doc/guides/cryptodevs/qat.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2015-2019 Intel Corporation.
   3
   4 Intel(R) QuickAssist (QAT) Crypto Poll Mode Driver
   5 ==================================================
   6
   7 QAT documentation consists of three parts:
   8
   9 * Details of the symmetric and asymmetric crypto services below.
  10 * Details of the :doc:`compression service <../compressdevs/qat_comp>`
  11   in the compressdev drivers section.
  12 * Details of building the common QAT infrastructure and the PMDs to support the
  13   above services. See :ref:`building_qat` below.
  14
  15
  16 Symmetric Crypto Service on QAT
  17 -------------------------------
  18
  19 The QAT symmetric crypto PMD (hereafter referred to as `QAT SYM [PMD]`) provides
  20 poll mode crypto driver support for the following hardware accelerator devices:
  21
  22 * ``Intel QuickAssist Technology DH895xCC``
  23 * ``Intel QuickAssist Technology C62x``
  24 * ``Intel QuickAssist Technology C3xxx``
  25 * ``Intel QuickAssist Technology 200xx``
  26 * ``Intel QuickAssist Technology D15xx``
  27 * ``Intel QuickAssist Technology C4xxx``
  28 * ``Intel QuickAssist Technology 4xxx``
  29
  30
  31 Features
  32 ~~~~~~~~
  33
  34 The QAT SYM PMD has support for:
  35
  36 Cipher algorithms:
  37
  38 * ``RTE_CRYPTO_CIPHER_3DES_CBC``
  39 * ``RTE_CRYPTO_CIPHER_3DES_CTR``
  40 * ``RTE_CRYPTO_CIPHER_AES128_CBC``
  41 * ``RTE_CRYPTO_CIPHER_AES192_CBC``
  42 * ``RTE_CRYPTO_CIPHER_AES256_CBC``
  43 * ``RTE_CRYPTO_CIPHER_AES128_CTR``
  44 * ``RTE_CRYPTO_CIPHER_AES192_CTR``
  45 * ``RTE_CRYPTO_CIPHER_AES256_CTR``
  46 * ``RTE_CRYPTO_CIPHER_AES_XTS``
  47 * ``RTE_CRYPTO_CIPHER_SNOW3G_UEA2``
  48 * ``RTE_CRYPTO_CIPHER_NULL``
  49 * ``RTE_CRYPTO_CIPHER_KASUMI_F8``
  50 * ``RTE_CRYPTO_CIPHER_DES_CBC``
  51 * ``RTE_CRYPTO_CIPHER_AES_DOCSISBPI``
  52 * ``RTE_CRYPTO_CIPHER_DES_DOCSISBPI``
  53 * ``RTE_CRYPTO_CIPHER_ZUC_EEA3``
  54
  55 Hash algorithms:
  56
  57 * ``RTE_CRYPTO_AUTH_SHA1``
  58 * ``RTE_CRYPTO_AUTH_SHA1_HMAC``
  59 * ``RTE_CRYPTO_AUTH_SHA224``
  60 * ``RTE_CRYPTO_AUTH_SHA224_HMAC``
  61 * ``RTE_CRYPTO_AUTH_SHA256``
  62 * ``RTE_CRYPTO_AUTH_SHA256_HMAC``
  63 * ``RTE_CRYPTO_AUTH_SHA384``
  64 * ``RTE_CRYPTO_AUTH_SHA384_HMAC``
  65 * ``RTE_CRYPTO_AUTH_SHA512``
  66 * ``RTE_CRYPTO_AUTH_SHA512_HMAC``
  67 * ``RTE_CRYPTO_AUTH_AES_XCBC_MAC``
  68 * ``RTE_CRYPTO_AUTH_SNOW3G_UIA2``
  69 * ``RTE_CRYPTO_AUTH_MD5_HMAC``
  70 * ``RTE_CRYPTO_AUTH_NULL``
  71 * ``RTE_CRYPTO_AUTH_KASUMI_F9``
  72 * ``RTE_CRYPTO_AUTH_AES_GMAC``
  73 * ``RTE_CRYPTO_AUTH_ZUC_EIA3``
  74 * ``RTE_CRYPTO_AUTH_AES_CMAC``
  75
  76 Supported AEAD algorithms:
  77
  78 * ``RTE_CRYPTO_AEAD_AES_GCM``
  79 * ``RTE_CRYPTO_AEAD_AES_CCM``
  80 * ``RTE_CRYPTO_AEAD_CHACHA20_POLY1305``
  81
  82 Protocol offloads:
  83
  84 * ``RTE_SECURITY_PROTOCOL_DOCSIS``
  85
  86 Supported Chains
  87 ~~~~~~~~~~~~~~~~
  88
  89 All the usual chains are supported and also some mixed chains:
  90
  91 .. table:: Supported hash-cipher chains for wireless digest-encrypted cases
  92
  93    +------------------+-----------+-------------+----------+----------+
  94    | Cipher algorithm | NULL AUTH | SNOW3G UIA2 | ZUC EIA3 | AES CMAC |
  95    +==================+===========+=============+==========+==========+
  96    | NULL CIPHER      | Y         | 2&3         | 2&3      | Y        |
  97    +------------------+-----------+-------------+----------+----------+
  98    | SNOW3G UEA2      | 2&3       | 1&2&3       | 2&3      | 2&3      |
  99    +------------------+-----------+-------------+----------+----------+
 100    | ZUC EEA3         | 2&3       | 2&3         | 2&3      | 2&3      |
 101    +------------------+-----------+-------------+----------+----------+
 102    | AES CTR          | 1&2&3     | 2&3         | 2&3      | Y        |
 103    +------------------+-----------+-------------+----------+----------+
 104
 105 * The combinations marked as "Y" are supported on all QAT hardware versions.
 106 * The combinations marked as "2&3" are supported on GEN2 and GEN3 QAT hardware only.
 107 * The combinations marked as "1&2&3" are supported on GEN1, GEN2 and GEN3 QAT hardware only.
 108
 109
 110 Limitations
 111 ~~~~~~~~~~~
 112
 113 * Only supports the session-oriented API implementation (session-less APIs are not supported).
 114 * SNOW 3G (UEA2), KASUMI (F8) and ZUC (EEA3) supported only if cipher length and offset fields are byte-multiple.
 115 * SNOW 3G (UIA2) and ZUC (EIA3) supported only if hash length and offset fields are byte-multiple.
 116 * No BSD support as BSD QAT kernel driver not available.
 117 * ZUC EEA3/EIA3 is not supported by dh895xcc devices
 118 * Maximum additional authenticated data (AAD) for GCM is 240 bytes long and must be passed to the device in a buffer rounded up to the nearest block-size multiple (x16) and padded with zeros.
 119 * Queue-pairs are thread-safe on Intel CPUs but Queues are not (that is, within a single
 120   queue-pair all enqueues to the TX queue must be done from one thread and all dequeues
 121   from the RX queue must be done from one thread, but enqueues and dequeues may be done
 122   in different threads.)
 123 * A GCM limitation exists, but only in the case where there are multiple
 124   generations of QAT devices on a single platform.
 125   To optimise performance, the GCM crypto session should be initialised for the
 126   device generation to which the ops will be enqueued. Specifically if a GCM
 127   session is initialised on a GEN2 device, but then attached to an op enqueued
 128   to a GEN3 device, it will work but cannot take advantage of hardware
 129   optimisations in the GEN3 device. And if a GCM session is initialised on a
 130   GEN3 device, then attached to an op sent to a GEN1/GEN2 device, it will not be
 131   enqueued to the device and will be marked as failed. The simplest way to
 132   mitigate this is to use the PCI allowlist to avoid mixing devices of different
 133   generations in the same process if planning to use for GCM.
 134 * The mixed algo feature on GEN2 is not supported by all kernel drivers. Check
 135   the notes under the Available Kernel Drivers table below for specific details.
 136 * Out-of-place is not supported for combined Crypto-CRC DOCSIS security
 137   protocol.
 138 * ``RTE_CRYPTO_CIPHER_DES_DOCSISBPI`` is not supported for combined Crypto-CRC
 139   DOCSIS security protocol.
 140 * Multi-segment buffers are not supported for combined Crypto-CRC DOCSIS
 141   security protocol.
 142
 143 Extra notes on KASUMI F9
 144 ~~~~~~~~~~~~~~~~~~~~~~~~
 145
 146 When using KASUMI F9 authentication algorithm, the input buffer must be
 147 constructed according to the
 148 `3GPP KASUMI specification <http://cryptome.org/3gpp/35201-900.pdf>`_
 149 (section 4.4, page 13). The input buffer has to have COUNT (4 bytes),
 150 FRESH (4 bytes), MESSAGE and DIRECTION (1 bit) concatenated. After the DIRECTION
 151 bit, a single '1' bit is appended, followed by between 0 and 7 '0' bits, so that
 152 the total length of the buffer is multiple of 8 bits. Note that the actual
 153 message can be any length, specified in bits.
 154
 155 Once this buffer is passed this way, when creating the crypto operation,
 156 length of data to authenticate "op.sym.auth.data.length" must be the length
 157 of all the items described above, including the padding at the end.
 158 Also, offset of data to authenticate "op.sym.auth.data.offset"
 159 must be such that points at the start of the COUNT bytes.
 160
 161 Asymmetric Crypto Service on QAT
 162 --------------------------------
 163
 164 The QAT asymmetric crypto PMD (hereafter referred to as `QAT ASYM [PMD]`) provides
 165 poll mode crypto driver support for the following hardware accelerator devices:
 166
 167 * ``Intel QuickAssist Technology DH895xCC``
 168 * ``Intel QuickAssist Technology C62x``
 169 * ``Intel QuickAssist Technology C3xxx``
 170 * ``Intel QuickAssist Technology D15xx``
 171 * ``Intel QuickAssist Technology C4xxx``
 172 * ``Intel QuickAssist Technology 4xxx``
 173
 174 The QAT ASYM PMD has support for:
 175
 176 * ``RTE_CRYPTO_ASYM_XFORM_MODEX``
 177 * ``RTE_CRYPTO_ASYM_XFORM_MODINV``
 178 * ``RTE_CRYPTO_ASYM_XFORM_RSA``
 179 * ``RTE_CRYPTO_ASYM_XFORM_ECDSA``
 180 * ``RTE_CRYPTO_ASYM_XFORM_ECPM``
 181
 182 Limitations
 183 ~~~~~~~~~~~
 184
 185 * Big integers longer than 4096 bits are not supported.
 186 * Queue-pairs are thread-safe on Intel CPUs but Queues are not (that is, within a single
 187   queue-pair all enqueues to the TX queue must be done from one thread and all dequeues
 188   from the RX queue must be done from one thread, but enqueues and dequeues may be done
 189   in different threads.)
 190 * RSA-2560, RSA-3584 are not supported
 191
 192 .. _building_qat:
 193
 194 Building PMDs on QAT
 195 --------------------
 196
 197 A QAT device can host multiple acceleration services:
 198
 199 * symmetric cryptography
 200 * data compression
 201 * asymmetric cryptography
 202
 203 These services are provided to DPDK applications via PMDs which register to
 204 implement the corresponding cryptodev and compressdev APIs. The PMDs use
 205 common QAT driver code which manages the QAT PCI device. They also depend on a
 206 QAT kernel driver being installed on the platform, see :ref:`qat_kernel` below.
 207
 208
 209 Configuring and Building the DPDK QAT PMDs
 210 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 211
 212
 213 Further information on configuring, building and installing DPDK is described
 214 :doc:`here <../linux_gsg/build_dpdk>`.
 215
 216 .. _building_qat_config:
 217
 218 Build Configuration
 219 ~~~~~~~~~~~~~~~~~~~
 220
 221 These are the build configuration options affecting QAT, and their default values:
 222
 223 .. code-block:: console
 224
 225         RTE_PMD_QAT_MAX_PCI_DEVICES=48
 226         RTE_PMD_QAT_COMP_IM_BUFFER_SIZE=65536
 227
 228 Both QAT SYM PMD and QAT ASYM PMD have an external dependency on libcrypto, so are not
 229 built by default.
 230
 231 The QAT compressdev PMD has no external dependencies, so is built by default.
 232
 233 The number of VFs per PF varies - see table below. If multiple QAT packages are
 234 installed on a platform then RTE_PMD_QAT_MAX_PCI_DEVICES should be
 235 adjusted to the number of VFs which the QAT common code will need to handle.
 236
 237 .. Note::
 238
 239         There are separate config items (not QAT-specific) for max cryptodevs
 240         RTE_CRYPTO_MAX_DEVS and max compressdevs RTE_COMPRESS_MAX_DEVS,
 241         if necessary these should be adjusted to handle the total of QAT and other
 242         devices which the process will use. In particular for crypto, where each
 243         QAT VF may expose two crypto devices, sym and asym, it may happen that the
 244         number of devices will be bigger than MAX_DEVS and the process will show an error
 245         during PMD initialisation. To avoid this problem RTE_CRYPTO_MAX_DEVS may be
 246         increased or -a, allow domain:bus:devid:func option may be used.
 247
 248
 249 QAT compression PMD needs intermediate buffers to support Deflate compression
 250 with Dynamic Huffman encoding. RTE_PMD_QAT_COMP_IM_BUFFER_SIZE
 251 specifies the size of a single buffer, the PMD will allocate a multiple of these,
 252 plus some extra space for associated meta-data. For GEN2 devices, 20 buffers are
 253 allocated while for GEN1 devices, 12 buffers are allocated, plus 1472 bytes overhead.
 254
 255 .. Note::
 256
 257         If the compressed output of a Deflate operation using Dynamic Huffman
 258         Encoding is too big to fit in an intermediate buffer, then the
 259         operation will be split into smaller operations and their results will
 260         be merged afterwards.
 261         This is not possible if any checksum calculation was requested - in such
 262         case the code falls back to fixed compression.
 263         To avoid this less performant case, applications should configure
 264         the intermediate buffer size to be larger than the expected input data size
 265         (compressed output size is usually unknown, so the only option is to make
 266         larger than the input size).
 267
 268
 269 Running QAT PMD with minimum threshold for burst size
 270 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 271
 272 If only a small number or packets can be enqueued. Each enqueue causes an expensive MMIO write.
 273 These MMIO write occurrences can be optimised by setting any of the following parameters:
 274
 275 - qat_sym_enq_threshold
 276 - qat_asym_enq_threshold
 277 - qat_comp_enq_threshold
 278
 279 When any of these parameters is set rte_cryptodev_enqueue_burst function will
 280 return 0 (thereby avoiding an MMIO) if the device is congested and number of packets
 281 possible to enqueue is smaller.
 282 To use this feature the user must set the parameter on process start as a device additional parameter::
 283
 284   -a 03:01.1,qat_sym_enq_threshold=32,qat_comp_enq_threshold=16
 285
 286 All parameters can be used with the same device regardless of order. Parameters are separated
 287 by comma. When the same parameter is used more than once first occurrence of the parameter
 288 is used.
 289 Maximum threshold that can be set is 32.
 290
 291
 292 Device and driver naming
 293 ~~~~~~~~~~~~~~~~~~~~~~~~
 294
 295 * The qat cryptodev symmetric crypto driver name is "crypto_qat".
 296 * The qat cryptodev asymmetric crypto driver name is "crypto_qat_asym".
 297
 298 The "rte_cryptodev_devices_get()" returns the devices exposed by either of these drivers.
 299
 300 * Each qat sym crypto device has a unique name, in format
 301   "<pci bdf>_<service>", e.g. "0000:41:01.0_qat_sym".
 302 * Each qat asym crypto device has a unique name, in format
 303   "<pci bdf>_<service>", e.g. "0000:41:01.0_qat_asym".
 304   This name can be passed to "rte_cryptodev_get_dev_id()" to get the device_id.
 305
 306 .. Note::
 307
 308         The cryptodev driver name is passed to the dpdk-test-crypto-perf tool in the "-devtype" parameter.
 309
 310         The qat crypto device name is in the format of the worker parameter passed to the crypto scheduler.
 311
 312 * The qat compressdev driver name is "compress_qat".
 313   The rte_compressdev_devices_get() returns the devices exposed by this driver.
 314
 315 * Each qat compression device has a unique name, in format
 316   <pci bdf>_<service>, e.g. "0000:41:01.0_qat_comp".
 317   This name can be passed to rte_compressdev_get_dev_id() to get the device_id.
 318
 319 .. _qat_kernel:
 320
 321 Dependency on the QAT kernel driver
 322 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 323
 324 To use QAT an SRIOV-enabled QAT kernel driver is required. The VF
 325 devices created and initialised by this driver will be used by the QAT PMDs.
 326
 327 Instructions for installation are below, but first an explanation of the
 328 relationships between the PF/VF devices and the PMDs visible to
 329 DPDK applications.
 330
 331 Each QuickAssist PF device exposes a number of VF devices. Each VF device can
 332 enable one symmetric cryptodev PMD and/or one asymmetric cryptodev PMD and/or
 333 one compressdev PMD.
 334 These QAT PMDs share the same underlying device and pci-mgmt code, but are
 335 enumerated independently on their respective APIs and appear as independent
 336 devices to applications.
 337
 338 .. Note::
 339
 340    Each VF can only be used by one DPDK process. It is not possible to share
 341    the same VF across multiple processes, even if these processes are using
 342    different acceleration services.
 343
 344    Conversely one DPDK process can use one or more QAT VFs and can expose both
 345    cryptodev and compressdev instances on each of those VFs.
 346
 347
 348 Available kernel drivers
 349 ~~~~~~~~~~~~~~~~~~~~~~~~
 350
 351 Kernel drivers for each device for each service are listed in the following table. (Scroll right
 352 to see the full table)
 353
 354
 355 .. _table_qat_pmds_drivers:
 356
 357 .. table:: QAT device generations, devices and drivers
 358
 359    +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
 360    | S   | A   | C   | Gen | Device   | Driver/ver    | Kernel Module | Pci Driver | PF Did | #PFs | VF Did | VFs/PF |
 361    +=====+=====+=====+=====+==========+===============+===============+============+========+======+========+========+
 362    | Yes | No  | No  | 1   | DH895xCC | linux/4.4+    | qat_dh895xcc  | dh895xcc   | 435    | 1    | 443    | 32     |
 363    +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
 364    | Yes | Yes | No  | "   | "        | 01.org/4.2.0+ | "             | "          | "      | "    | "      | "      |
 365    +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
 366    | Yes | Yes | Yes | "   | "        | 01.org/4.3.0+ | "             | "          | "      | "    | "      | "      |
 367    +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
 368    | Yes | No  | No  | 2   | C62x     | linux/4.5+    | qat_c62x      | c6xx       | 37c8   | 3    | 37c9   | 16     |
 369    +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
 370    | Yes | Yes | Yes | "   | "        | 01.org/4.2.0+ | "             | "          | "      | "    | "      | "      |
 371    +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
 372    | Yes | No  | No  | 2   | C3xxx    | linux/4.5+    | qat_c3xxx     | c3xxx      | 19e2   | 1    | 19e3   | 16     |
 373    +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
 374    | Yes | Yes | Yes | "   | "        | 01.org/4.2.0+ | "             | "          | "      | "    | "      | "      |
 375    +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
 376    | Yes | No  | No  | 2   | 200xx    | p             | qat_200xx     | 200xx      | 18ee   | 1    | 18ef   | 16     |
 377    +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
 378    | Yes | No  | No  | 2   | D15xx    | 01.org/4.2.0+ | qat_d15xx     | d15xx      | 6f54   | 1    | 6f55   | 16     |
 379    +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
 380    | Yes | No  | No  | 3   | C4xxx    | p             | qat_c4xxx     | c4xxx      | 18a0   | 1    | 18a1   | 128    |
 381    +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
 382    | Yes | No  | No  | 4   | 4xxx     | N/A           | qat_4xxx      | 4xxx       | 4940   | 4    | 4941   | 16     |
 383    +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
 384    | Yes | No  | No  | 4   | 401xxx   | N/A           | qat_401xxx    | 4xxx       | 4942   | 2    | 4943   | 16     |
 385    +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
 386
 387 * Note: Symmetric mixed crypto algorithms feature on Gen 2 works only with 01.org driver version 4.9.0+
 388
 389 The first 3 columns indicate the service:
 390
 391 * S = Symmetric crypto service (via cryptodev API)
 392 * A = Asymmetric crypto service  (via cryptodev API)
 393 * C = Compression service (via compressdev API)
 394
 395 The ``Driver`` column indicates either the Linux kernel version in which
 396 support for this device was introduced or a driver available on Intel's 01.org
 397 website. There are both linux in-tree and 01.org kernel drivers available for some
 398 devices. p = release pending.
 399
 400 If you are running on a kernel which includes a driver for your device, see
 401 `Installation using kernel.org driver`_ below. Otherwise see
 402 `Installation using 01.org QAT driver`_.
 403
 404
 405 Installation using kernel.org driver
 406 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 407
 408 The examples below are based on the C62x device, if you have a different device
 409 use the corresponding values in the above table.
 410
 411 In BIOS ensure that SRIOV is enabled and either:
 412
 413 * Disable VT-d or
 414 * Enable VT-d and set ``"intel_iommu=on iommu=pt"`` in the grub file.
 415
 416 Check that the QAT driver is loaded on your system, by executing::
 417
 418     lsmod | grep qa
 419
 420 You should see the kernel module for your device listed, e.g.::
 421
 422     qat_c62x               5626  0
 423     intel_qat              82336  1 qat_c62x
 424
 425 Next, you need to expose the Virtual Functions (VFs) using the sysfs file system.
 426
 427 First find the BDFs (Bus-Device-Function) of the physical functions (PFs) of
 428 your device, e.g.::
 429
 430     lspci -d:37c8
 431
 432 You should see output similar to::
 433
 434     1a:00.0 Co-processor: Intel Corporation Device 37c8
 435     3d:00.0 Co-processor: Intel Corporation Device 37c8
 436     3f:00.0 Co-processor: Intel Corporation Device 37c8
 437
 438 Enable the VFs for each PF by echoing the number of VFs per PF to the pci driver::
 439
 440      echo 16 > /sys/bus/pci/drivers/c6xx/0000:1a:00.0/sriov_numvfs
 441      echo 16 > /sys/bus/pci/drivers/c6xx/0000:3d:00.0/sriov_numvfs
 442      echo 16 > /sys/bus/pci/drivers/c6xx/0000:3f:00.0/sriov_numvfs
 443
 444 Check that the VFs are available for use. For example ``lspci -d:37c9`` should
 445 list 48 VF devices available for a ``C62x`` device.
 446
 447 To complete the installation follow the instructions in
 448 `Binding the available VFs to the vfio-pci driver`_.
 449
 450 .. Note::
 451
 452    If the QAT kernel modules are not loaded and you see an error like ``Failed
 453    to load MMP firmware qat_895xcc_mmp.bin`` in kernel logs, this may be as a
 454    result of not using a distribution, but just updating the kernel directly.
 455
 456    Download firmware from the `kernel firmware repo
 457    <http://git.kernel.org/cgit/linux/kernel/git/firmware/linux-firmware.git/tree/>`_.
 458
 459    Copy qat binaries to ``/lib/firmware``::
 460
 461       cp qat_895xcc.bin /lib/firmware
 462       cp qat_895xcc_mmp.bin /lib/firmware
 463
 464    Change to your linux source root directory and start the qat kernel modules::
 465
 466       insmod ./drivers/crypto/qat/qat_common/intel_qat.ko
 467       insmod ./drivers/crypto/qat/qat_dh895xcc/qat_dh895xcc.ko
 468
 469 .. Note::
 470
 471    If you see the following warning in ``/var/log/messages`` it can be ignored:
 472    ``IOMMU should be enabled for SR-IOV to work correctly``.
 473
 474
 475 Installation using 01.org QAT driver
 476 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 477
 478 Download the latest QuickAssist Technology Driver from `01.org
 479 <https://01.org/packet-processing/intel%C2%AE-quickassist-technology-drivers-and-patches>`_.
 480 Consult the *Getting Started Guide* at the same URL for further information.
 481
 482 The steps below assume you are:
 483
 484 * Building on a platform with one ``C62x`` device.
 485 * Using package ``qat1.7.l.4.2.0-000xx.tar.gz``.
 486 * On Fedora26 kernel ``4.11.11-300.fc26.x86_64``.
 487
 488 In the BIOS ensure that SRIOV is enabled and VT-d is disabled.
 489
 490 Uninstall any existing QAT driver, for example by running:
 491
 492 * ``./installer.sh uninstall`` in the directory where originally installed.
 493
 494
 495 Build and install the SRIOV-enabled QAT driver::
 496
 497     mkdir /QAT
 498     cd /QAT
 499
 500     # Copy the package to this location and unpack
 501     tar zxof qat1.7.l.4.2.0-000xx.tar.gz
 502
 503     ./configure --enable-icp-sriov=host
 504     make install
 505
 506 You can use ``cat /sys/kernel/debug/qat<your device type and bdf>/version/fw`` to confirm the driver is correctly installed and is using firmware version 4.2.0.
 507 You can use ``lspci -d:37c9`` to confirm the presence of the 16 VF devices available per ``C62x`` PF.
 508
 509 Confirm the driver is correctly installed and is using firmware version 4.2.0::
 510
 511     cat /sys/kernel/debug/qat<your device type and bdf>/version/fw
 512
 513
 514 Confirm the presence of 48 VF devices - 16 per PF::
 515
 516     lspci -d:37c9
 517
 518
 519 To complete the installation - follow instructions in
 520 `Binding the available VFs to the vfio-pci driver`_.
 521
 522 .. Note::
 523
 524    If using a later kernel and the build fails with an error relating to
 525    ``strict_stroul`` not being available apply the following patch:
 526
 527    .. code-block:: diff
 528
 529       /QAT/QAT1.6/quickassist/utilities/downloader/Target_CoreLibs/uclo/include/linux/uclo_platform.h
 530       + #if LINUX_VERSION_CODE >= KERNEL_VERSION(3,18,5)
 531       + #define STR_TO_64(str, base, num, endPtr) {endPtr=NULL; if (kstrtoul((str), (base), (num))) printk("Error strtoull convert %s\n", str); }
 532       + #else
 533       #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,38)
 534       #define STR_TO_64(str, base, num, endPtr) {endPtr=NULL; if (strict_strtoull((str), (base), (num))) printk("Error strtoull convert %s\n", str); }
 535       #else
 536       #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,25)
 537       #define STR_TO_64(str, base, num, endPtr) {endPtr=NULL; strict_strtoll((str), (base), (num));}
 538       #else
 539       #define STR_TO_64(str, base, num, endPtr)                                 \
 540            do {                                                               \
 541                  if (str[0] == '-')                                           \
 542                  {                                                            \
 543                       *(num) = -(simple_strtoull((str+1), &(endPtr), (base))); \
 544                  }else {                                                      \
 545                       *(num) = simple_strtoull((str), &(endPtr), (base));      \
 546                  }                                                            \
 547            } while(0)
 548       + #endif
 549       #endif
 550       #endif
 551
 552
 553 .. Note::
 554
 555    If the build fails due to missing header files you may need to do following::
 556
 557       sudo yum install zlib-devel
 558       sudo yum install openssl-devel
 559       sudo yum install libudev-devel
 560
 561 .. Note::
 562
 563    If the build or install fails due to mismatching kernel sources you may need to do the following::
 564
 565       sudo yum install kernel-headers-`uname -r`
 566       sudo yum install kernel-src-`uname -r`
 567       sudo yum install kernel-devel-`uname -r`
 568
 569
 570 Binding the available VFs to the vfio-pci driver
 571 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 572
 573 Note:
 574
 575 * Please note that due to security issues, the usage of older DPDK igb_uio
 576   driver is not recommended. This document shows how to use the more secure
 577   vfio-pci driver.
 578 * If QAT fails to bind to vfio-pci on Linux kernel 5.9+, please see the
 579   QATE-39220 and QATE-7495 issues in
 580   `01.org doc <https://01.org/sites/default/files/downloads/336211-015-qatsoftwareforlinux-rn-hwv1.7-final.pdf>`_
 581   which details the constraint about trusted guests and add `disable_denylist=1`
 582   to the vfio-pci params to use QAT. See also `this patch description <https://lkml.org/lkml/2020/7/23/1155>`_.
 583
 584 Unbind the VFs from the stock driver so they can be bound to the vfio-pci driver.
 585
 586 For an Intel(R) QuickAssist Technology DH895xCC device
 587 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 588
 589 The unbind command below assumes ``BDFs`` of ``03:01.00-03:04.07``, if your
 590 VFs are different adjust the unbind command below::
 591
 592     cd to the top-level DPDK directory
 593     for device in $(seq 1 4); do \
 594         for fn in $(seq 0 7); do \
 595             usertools/dpdk-devbind.py -u 0000:03:0${device}.${fn}; \
 596         done; \
 597     done
 598
 599 For an Intel(R) QuickAssist Technology C62x device
 600 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 601
 602 The unbind command below assumes ``BDFs`` of ``1a:01.00-1a:02.07``,
 603 ``3d:01.00-3d:02.07`` and ``3f:01.00-3f:02.07``, if your VFs are different
 604 adjust the unbind command below::
 605
 606     cd to the top-level DPDK directory
 607     for device in $(seq 1 2); do \
 608         for fn in $(seq 0 7); do \
 609             usertools/dpdk-devbind.py -u 0000:1a:0${device}.${fn}; \
 610             usertools/dpdk-devbind.py -u 0000:3d:0${device}.${fn}; \
 611             usertools/dpdk-devbind.py -u 0000:3f:0${device}.${fn}; \
 612         done; \
 613     done
 614
 615 For Intel(R) QuickAssist Technology C3xxx or 200xx or D15xx device
 616 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 617
 618 The unbind command below assumes ``BDFs`` of ``01:01.00-01:02.07``, if your
 619 VFs are different adjust the unbind command below::
 620
 621     cd to the top-level DPDK directory
 622     for device in $(seq 1 2); do \
 623         for fn in $(seq 0 7); do \
 624             usertools/dpdk-devbind.py -u 0000:01:0${device}.${fn}; \
 625         done; \
 626     done
 627
 628 Bind to the vfio-pci driver
 629 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 630
 631 Load the vfio-pci driver, bind the VF PCI Device id to it using the
 632 ``dpdk-devbind.py`` script then use the ``--status`` option
 633 to confirm the VF devices are now in use by vfio-pci kernel driver,
 634 e.g. for the C62x device::
 635
 636     cd to the top-level DPDK directory
 637     modprobe vfio-pci
 638     usertools/dpdk-devbind.py -b vfio-pci 0000:03:01.1
 639     usertools/dpdk-devbind.py --status
 640
 641 Use ``modprobe vfio-pci disable_denylist=1`` from kernel 5.9 onwards.
 642 See note in the section `Binding the available VFs to the vfio-pci driver`_
 643 above.
 644
 645 Testing
 646 ~~~~~~~
 647
 648 QAT SYM crypto PMD can be tested by running the test application::
 649
 650     cd ./<build_dir>/app/test
 651     ./dpdk-test -l1 -n1 -a <your qat bdf>
 652     RTE>>cryptodev_qat_autotest
 653
 654 QAT ASYM crypto PMD can be tested by running the test application::
 655
 656     cd ./<build_dir>/app/test
 657     ./dpdk-test -l1 -n1 -a <your qat bdf>
 658     RTE>>cryptodev_qat_asym_autotest
 659
 660 QAT compression PMD can be tested by running the test application::
 661
 662     cd ./<build_dir>/app/test
 663     ./dpdk-test -l1 -n1 -a <your qat bdf>
 664     RTE>>compressdev_autotest
 665
 666
 667 Debugging
 668 ~~~~~~~~~
 669
 670 There are 2 sets of trace available via the dynamic logging feature:
 671
 672 * pmd.qat.dp exposes trace on the data-path.
 673 * pmd.qat.general exposes all other trace.
 674
 675 pmd.qat exposes both sets of traces.
 676 They can be enabled using the log-level option (where 8=maximum log level) on
 677 the process cmdline, e.g. using any of the following::
 678
 679     --log-level="pmd.qat.general,8"
 680     --log-level="pmd.qat.dp,8"
 681     --log-level="pmd.qat,8"
 682
 683 .. Note::
 684
 685     The global RTE_LOG_DP_LEVEL overrides data-path trace so must be set to
 686     RTE_LOG_DEBUG to see all the trace. This variable is in config/rte_config.h
 687     for meson build.
 688     Also the dynamic global log level overrides both sets of trace, so e.g. no
 689     QAT trace would display in this case::
 690
 691         --log-level="7" --log-level="pmd.qat.general,8"