doc/guides/cryptodevs/qat.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2015-2016 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 crypto service below.
  10 * Details of the `compression service <http://dpdk.org/doc/guides/compressdevs/qat_comp.html>`_
  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 crypto PMD provides poll mode crypto driver support for the following
  20 hardware accelerator devices:
  21
  22 * ``Intel QuickAssist Technology DH895xCC``
  23 * ``Intel QuickAssist Technology C62x``
  24 * ``Intel QuickAssist Technology C3xxx``
  25 * ``Intel QuickAssist Technology D15xx``
  26
  27
  28 Features
  29 ~~~~~~~~
  30
  31 The QAT PMD has support for:
  32
  33 Cipher algorithms:
  34
  35 * ``RTE_CRYPTO_CIPHER_3DES_CBC``
  36 * ``RTE_CRYPTO_CIPHER_3DES_CTR``
  37 * ``RTE_CRYPTO_CIPHER_AES128_CBC``
  38 * ``RTE_CRYPTO_CIPHER_AES192_CBC``
  39 * ``RTE_CRYPTO_CIPHER_AES256_CBC``
  40 * ``RTE_CRYPTO_CIPHER_AES128_CTR``
  41 * ``RTE_CRYPTO_CIPHER_AES192_CTR``
  42 * ``RTE_CRYPTO_CIPHER_AES256_CTR``
  43 * ``RTE_CRYPTO_CIPHER_SNOW3G_UEA2``
  44 * ``RTE_CRYPTO_CIPHER_NULL``
  45 * ``RTE_CRYPTO_CIPHER_KASUMI_F8``
  46 * ``RTE_CRYPTO_CIPHER_DES_CBC``
  47 * ``RTE_CRYPTO_CIPHER_AES_DOCSISBPI``
  48 * ``RTE_CRYPTO_CIPHER_DES_DOCSISBPI``
  49 * ``RTE_CRYPTO_CIPHER_ZUC_EEA3``
  50
  51 Hash algorithms:
  52
  53 * ``RTE_CRYPTO_AUTH_SHA1_HMAC``
  54 * ``RTE_CRYPTO_AUTH_SHA224_HMAC``
  55 * ``RTE_CRYPTO_AUTH_SHA256_HMAC``
  56 * ``RTE_CRYPTO_AUTH_SHA384_HMAC``
  57 * ``RTE_CRYPTO_AUTH_SHA512_HMAC``
  58 * ``RTE_CRYPTO_AUTH_AES_XCBC_MAC``
  59 * ``RTE_CRYPTO_AUTH_SNOW3G_UIA2``
  60 * ``RTE_CRYPTO_AUTH_MD5_HMAC``
  61 * ``RTE_CRYPTO_AUTH_NULL``
  62 * ``RTE_CRYPTO_AUTH_KASUMI_F9``
  63 * ``RTE_CRYPTO_AUTH_AES_GMAC``
  64 * ``RTE_CRYPTO_AUTH_ZUC_EIA3``
  65
  66 Supported AEAD algorithms:
  67
  68 * ``RTE_CRYPTO_AEAD_AES_GCM``
  69
  70
  71 Limitations
  72 ~~~~~~~~~~~
  73
  74 * Only supports the session-oriented API implementation (session-less APIs are not supported).
  75 * SNOW 3G (UEA2), KASUMI (F8) and ZUC (EEA3) supported only if cipher length and offset fields are byte-multiple.
  76 * SNOW 3G (UIA2) and ZUC (EIA3) supported only if hash length and offset fields are byte-multiple.
  77 * No BSD support as BSD QAT kernel driver not available.
  78 * ZUC EEA3/EIA3 is not supported by dh895xcc devices
  79 * Maximum additional authenticated data (AAD) for GCM is 240 bytes long.
  80 * Queue pairs are not thread-safe (that is, within a single queue pair, RX and TX from different lcores is not supported).
  81
  82
  83 Extra notes on KASUMI F9
  84 ~~~~~~~~~~~~~~~~~~~~~~~~
  85
  86 When using KASUMI F9 authentication algorithm, the input buffer must be
  87 constructed according to the
  88 `3GPP KASUMI specification <http://cryptome.org/3gpp/35201-900.pdf>`_
  89 (section 4.4, page 13). The input buffer has to have COUNT (4 bytes),
  90 FRESH (4 bytes), MESSAGE and DIRECTION (1 bit) concatenated. After the DIRECTION
  91 bit, a single '1' bit is appended, followed by between 0 and 7 '0' bits, so that
  92 the total length of the buffer is multiple of 8 bits. Note that the actual
  93 message can be any length, specified in bits.
  94
  95 Once this buffer is passed this way, when creating the crypto operation,
  96 length of data to authenticate "op.sym.auth.data.length" must be the length
  97 of all the items described above, including the padding at the end.
  98 Also, offset of data to authenticate "op.sym.auth.data.offset"
  99 must be such that points at the start of the COUNT bytes.
 100
 101
 102
 103 .. _building_qat:
 104
 105 Building PMDs on QAT
 106 --------------------
 107
 108 A QAT device can host multiple acceleration services:
 109
 110 * symmetric cryptography
 111 * data compression
 112
 113 These services are provided to DPDK applications via PMDs which register to
 114 implement the corresponding cryptodev and compressdev APIs. The PMDs use
 115 common QAT driver code which manages the QAT PCI device. They also depend on a
 116 QAT kernel driver being installed on the platform, see :ref:`qat_kernel` below.
 117
 118
 119 Configuring and Building the DPDK QAT PMDs
 120 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 121
 122
 123 Further information on configuring, building and installing DPDK is described
 124 `here <http://dpdk.org/doc/guides/linux_gsg/build_dpdk.html>`_.
 125
 126
 127 Quick instructions for QAT cryptodev PMD are as follows:
 128
 129 .. code-block:: console
 130
 131         cd to the top-level DPDK directory
 132         make defconfig
 133         sed -i 's,\(CONFIG_RTE_LIBRTE_PMD_QAT_SYM\)=n,\1=y,' build/.config
 134         make
 135
 136 Quick instructions for QAT compressdev PMD are as follows:
 137
 138 .. code-block:: console
 139
 140         cd to the top-level DPDK directory
 141         make defconfig
 142         make
 143
 144
 145
 146 Device and driver naming
 147 ~~~~~~~~~~~~~~~~~~~~~~~~
 148
 149 * The qat cryptodev driver name is "crypto_qat".
 150   The "rte_cryptodev_devices_get()" returns the devices exposed by this driver.
 151
 152 * Each qat crypto device has a unique name, in format
 153   "<pci bdf>_<service>", e.g. "0000:41:01.0_qat_sym".
 154   This name can be passed to "rte_cryptodev_get_dev_id()" to get the device_id.
 155
 156 .. Note::
 157
 158         The qat crypto driver name is passed to the dpdk-test-crypto-perf tool in the "-devtype" parameter.
 159
 160         The qat crypto device name is in the format of the slave parameter passed to the crypto scheduler.
 161
 162 * The qat compressdev driver name is "qat".
 163   The rte_compressdev_devices_get() returns the devices exposed by this driver.
 164
 165 * Each qat compression device has a unique name, in format
 166   <pci bdf>_<service>, e.g. "0000:41:01.0_qat_comp".
 167   This name can be passed to rte_compressdev_get_dev_id() to get the device_id.
 168
 169 .. _qat_kernel:
 170
 171 Dependency on the QAT kernel driver
 172 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 173
 174 To use QAT an SRIOV-enabled QAT kernel driver is required. The VF
 175 devices created and initialised by this driver will be used by the QAT PMDs.
 176
 177 Instructions for installation are below, but first an explanation of the
 178 relationships between the PF/VF devices and the PMDs visible to
 179 DPDK applications.
 180
 181 Each QuickAssist PF device exposes a number of VF devices. Each VF device can
 182 enable one cryptodev PMD and/or one compressdev PMD.
 183 These QAT PMDs share the same underlying device and pci-mgmt code, but are
 184 enumerated independently on their respective APIs and appear as independent
 185 devices to applications.
 186
 187 .. Note::
 188
 189    Each VF can only be used by one DPDK process. It is not possible to share
 190    the same VF across multiple processes, even if these processes are using
 191    different acceleration services.
 192
 193    Conversely one DPDK process can use one or more QAT VFs and can expose both
 194    cryptodev and compressdev instances on each of those VFs.
 195
 196
 197 Available kernel drivers
 198 ~~~~~~~~~~~~~~~~~~~~~~~~
 199
 200 Kernel drivers for each device are listed in the following table. Scroll right
 201 to check that the driver and device supports the service you require.
 202
 203
 204 .. _table_qat_pmds_drivers:
 205
 206 .. table:: QAT device generations, devices and drivers
 207
 208    +-----+----------+---------------+---------------+------------+--------+------+--------+--------+-----------+-------------+
 209    | Gen | Device   | Driver/ver    | Kernel Module | Pci Driver | PF Did | #PFs | VF Did | VFs/PF | cryptodev | compressdev |
 210    +=====+==========+===============+===============+============+========+======+========+========+===========+=============+
 211    | 1   | DH895xCC | linux/4.4+    | qat_dh895xcc  | dh895xcc   | 435    | 1    | 443    | 32     | Yes       | No          |
 212    +-----+----------+---------------+---------------+------------+--------+------+--------+--------+-----------+-------------+
 213    | "   | "        | 01.org/4.2.0+ | "             | "          | "      | "    | "      | "      | Yes       | No          |
 214    +-----+----------+---------------+---------------+------------+--------+------+--------+--------+-----------+-------------+
 215    | 2   | C62x     | linux/4.5+    | qat_c62x      | c6xx       | 37c8   | 3    | 37c9   | 16     | Yes       | No          |
 216    +-----+----------+---------------+---------------+------------+--------+------+--------+--------+-----------+-------------+
 217    | "   | "        | 01.org/4.2.0+ | "             | "          | "      | "    | "      | "      | Yes       | Yes         |
 218    +-----+----------+---------------+---------------+------------+--------+------+--------+--------+-----------+-------------+
 219    | 2   | C3xxx    | linux/4.5+    | qat_c3xxx     | c3xxx      | 19e2   | 1    | 19e3   | 16     | Yes       | No          |
 220    +-----+----------+---------------+---------------+------------+--------+------+--------+--------+-----------+-------------+
 221    | "   | "        | 01.org/4.2.0+ | "             | "          | "      | "    | "      | "      | Yes       | Yes         |
 222    +-----+----------+---------------+---------------+------------+--------+------+--------+--------+-----------+-------------+
 223    | 2   | D15xx    | p             | qat_d15xx     | d15xx      | 6f54   | 1    | 6f55   | 16     | Yes       | No          |
 224    +-----+----------+---------------+---------------+------------+--------+------+--------+--------+-----------+-------------+
 225
 226
 227 The ``Driver`` column indicates either the Linux kernel version in which
 228 support for this device was introduced or a driver available on Intel's 01.org
 229 website. There are both linux and 01.org kernel drivers available for some
 230 devices. p = release pending.
 231
 232 If you are running on a kernel which includes a driver for your device, see
 233 `Installation using kernel.org driver`_ below. Otherwise see
 234 `Installation using 01.org QAT driver`_.
 235
 236
 237 Installation using kernel.org driver
 238 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 239
 240 The examples below are based on the C62x device, if you have a different device
 241 use the corresponding values in the above table.
 242
 243 In BIOS ensure that SRIOV is enabled and either:
 244
 245 * Disable VT-d or
 246 * Enable VT-d and set ``"intel_iommu=on iommu=pt"`` in the grub file.
 247
 248 Check that the QAT driver is loaded on your system, by executing::
 249
 250     lsmod | grep qa
 251
 252 You should see the kernel module for your device listed, e.g.::
 253
 254     qat_c62x               5626  0
 255     intel_qat              82336  1 qat_c62x
 256
 257 Next, you need to expose the Virtual Functions (VFs) using the sysfs file system.
 258
 259 First find the BDFs (Bus-Device-Function) of the physical functions (PFs) of
 260 your device, e.g.::
 261
 262     lspci -d:37c8
 263
 264 You should see output similar to::
 265
 266     1a:00.0 Co-processor: Intel Corporation Device 37c8
 267     3d:00.0 Co-processor: Intel Corporation Device 37c8
 268     3f:00.0 Co-processor: Intel Corporation Device 37c8
 269
 270 Enable the VFs for each PF by echoing the number of VFs per PF to the pci driver::
 271
 272      echo 16 > /sys/bus/pci/drivers/c6xx/0000:1a:00.0/sriov_numvfs
 273      echo 16 > /sys/bus/pci/drivers/c6xx/0000:3d:00.0/sriov_numvfs
 274      echo 16 > /sys/bus/pci/drivers/c6xx/0000:3f:00.0/sriov_numvfs
 275
 276 Check that the VFs are available for use. For example ``lspci -d:37c9`` should
 277 list 48 VF devices available for a ``C62x`` device.
 278
 279 To complete the installation follow the instructions in
 280 `Binding the available VFs to the DPDK UIO driver`_.
 281
 282 .. Note::
 283
 284    If the QAT kernel modules are not loaded and you see an error like ``Failed
 285    to load MMP firmware qat_895xcc_mmp.bin`` in kernel logs, this may be as a
 286    result of not using a distribution, but just updating the kernel directly.
 287
 288    Download firmware from the `kernel firmware repo
 289    <http://git.kernel.org/cgit/linux/kernel/git/firmware/linux-firmware.git/tree/>`_.
 290
 291    Copy qat binaries to ``/lib/firmware``::
 292
 293       cp qat_895xcc.bin /lib/firmware
 294       cp qat_895xcc_mmp.bin /lib/firmware
 295
 296    Change to your linux source root directory and start the qat kernel modules::
 297
 298       insmod ./drivers/crypto/qat/qat_common/intel_qat.ko
 299       insmod ./drivers/crypto/qat/qat_dh895xcc/qat_dh895xcc.ko
 300
 301
 302 .. Note::
 303
 304    If you see the following warning in ``/var/log/messages`` it can be ignored:
 305    ``IOMMU should be enabled for SR-IOV to work correctly``.
 306
 307
 308 Installation using 01.org QAT driver
 309 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 310
 311 Download the latest QuickAssist Technology Driver from `01.org
 312 <https://01.org/packet-processing/intel%C2%AE-quickassist-technology-drivers-and-patches>`_.
 313 Consult the *Getting Started Guide* at the same URL for further information.
 314
 315 The steps below assume you are:
 316
 317 * Building on a platform with one ``C62x`` device.
 318 * Using package ``qat1.7.l.4.2.0-000xx.tar.gz``.
 319 * On Fedora26 kernel ``4.11.11-300.fc26.x86_64``.
 320
 321 In the BIOS ensure that SRIOV is enabled and VT-d is disabled.
 322
 323 Uninstall any existing QAT driver, for example by running:
 324
 325 * ``./installer.sh uninstall`` in the directory where originally installed.
 326
 327
 328 Build and install the SRIOV-enabled QAT driver::
 329
 330     mkdir /QAT
 331     cd /QAT
 332
 333     # Copy the package to this location and unpack
 334     tar zxof qat1.7.l.4.2.0-000xx.tar.gz
 335
 336     ./configure --enable-icp-sriov=host
 337     make install
 338
 339 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.
 340 You can use ``lspci -d:37c9`` to confirm the presence of the 16 VF devices available per ``C62x`` PF.
 341
 342 Confirm the driver is correctly installed and is using firmware version 4.2.0::
 343
 344     cat /sys/kernel/debug/qat<your device type and bdf>/version/fw
 345
 346
 347 Confirm the presence of 48 VF devices - 16 per PF::
 348
 349     lspci -d:37c9
 350
 351
 352 To complete the installation - follow instructions in `Binding the available VFs to the DPDK UIO driver`_.
 353
 354 .. Note::
 355
 356    If using a later kernel and the build fails with an error relating to
 357    ``strict_stroul`` not being available apply the following patch:
 358
 359    .. code-block:: diff
 360
 361       /QAT/QAT1.6/quickassist/utilities/downloader/Target_CoreLibs/uclo/include/linux/uclo_platform.h
 362       + #if LINUX_VERSION_CODE >= KERNEL_VERSION(3,18,5)
 363       + #define STR_TO_64(str, base, num, endPtr) {endPtr=NULL; if (kstrtoul((str), (base), (num))) printk("Error strtoull convert %s\n", str); }
 364       + #else
 365       #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,38)
 366       #define STR_TO_64(str, base, num, endPtr) {endPtr=NULL; if (strict_strtoull((str), (base), (num))) printk("Error strtoull convert %s\n", str); }
 367       #else
 368       #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,25)
 369       #define STR_TO_64(str, base, num, endPtr) {endPtr=NULL; strict_strtoll((str), (base), (num));}
 370       #else
 371       #define STR_TO_64(str, base, num, endPtr)                                 \
 372            do {                                                               \
 373                  if (str[0] == '-')                                           \
 374                  {                                                            \
 375                       *(num) = -(simple_strtoull((str+1), &(endPtr), (base))); \
 376                  }else {                                                      \
 377                       *(num) = simple_strtoull((str), &(endPtr), (base));      \
 378                  }                                                            \
 379            } while(0)
 380       + #endif
 381       #endif
 382       #endif
 383
 384
 385 .. Note::
 386
 387    If the build fails due to missing header files you may need to do following::
 388
 389       sudo yum install zlib-devel
 390       sudo yum install openssl-devel
 391       sudo yum install libudev-devel
 392
 393 .. Note::
 394
 395    If the build or install fails due to mismatching kernel sources you may need to do the following::
 396
 397       sudo yum install kernel-headers-`uname -r`
 398       sudo yum install kernel-src-`uname -r`
 399       sudo yum install kernel-devel-`uname -r`
 400
 401
 402 Binding the available VFs to the DPDK UIO driver
 403 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 404
 405 Unbind the VFs from the stock driver so they can be bound to the uio driver.
 406
 407 For an Intel(R) QuickAssist Technology DH895xCC device
 408 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 409
 410 The unbind command below assumes ``BDFs`` of ``03:01.00-03:04.07``, if your
 411 VFs are different adjust the unbind command below::
 412
 413     for device in $(seq 1 4); do \
 414         for fn in $(seq 0 7); do \
 415             echo -n 0000:03:0${device}.${fn} > \
 416             /sys/bus/pci/devices/0000\:03\:0${device}.${fn}/driver/unbind; \
 417         done; \
 418     done
 419
 420 For an Intel(R) QuickAssist Technology C62x device
 421 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 422
 423 The unbind command below assumes ``BDFs`` of ``1a:01.00-1a:02.07``,
 424 ``3d:01.00-3d:02.07`` and ``3f:01.00-3f:02.07``, if your VFs are different
 425 adjust the unbind command below::
 426
 427     for device in $(seq 1 2); do \
 428         for fn in $(seq 0 7); do \
 429             echo -n 0000:1a:0${device}.${fn} > \
 430             /sys/bus/pci/devices/0000\:1a\:0${device}.${fn}/driver/unbind; \
 431
 432             echo -n 0000:3d:0${device}.${fn} > \
 433             /sys/bus/pci/devices/0000\:3d\:0${device}.${fn}/driver/unbind; \
 434
 435             echo -n 0000:3f:0${device}.${fn} > \
 436             /sys/bus/pci/devices/0000\:3f\:0${device}.${fn}/driver/unbind; \
 437         done; \
 438     done
 439
 440 For Intel(R) QuickAssist Technology C3xxx or D15xx device
 441 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 442
 443 The unbind command below assumes ``BDFs`` of ``01:01.00-01:02.07``, if your
 444 VFs are different adjust the unbind command below::
 445
 446     for device in $(seq 1 2); do \
 447         for fn in $(seq 0 7); do \
 448             echo -n 0000:01:0${device}.${fn} > \
 449             /sys/bus/pci/devices/0000\:01\:0${device}.${fn}/driver/unbind; \
 450         done; \
 451     done
 452
 453 Bind to the DPDK uio driver
 454 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 455
 456 Install the DPDK igb_uio driver, bind the VF PCI Device id to it and use lspci
 457 to confirm the VF devices are now in use by igb_uio kernel driver,
 458 e.g. for the C62x device::
 459
 460     cd to the top-level DPDK directory
 461     modprobe uio
 462     insmod ./build/kmod/igb_uio.ko
 463     echo "8086 37c9" > /sys/bus/pci/drivers/igb_uio/new_id
 464     lspci -vvd:37c9
 465
 466
 467 Another way to bind the VFs to the DPDK UIO driver is by using the
 468 ``dpdk-devbind.py`` script::
 469
 470     cd to the top-level DPDK directory
 471     ./usertools/dpdk-devbind.py -b igb_uio 0000:03:01.1
 472
 473 Testing
 474 ~~~~~~~
 475
 476 QAT crypto PMD can be tested by running the test application::
 477
 478     make defconfig
 479     make test-build -j
 480     cd ./build/app
 481     ./test -l1 -n1 -w <your qat bdf>
 482     RTE>>cryptodev_qat_autotest
 483
 484 QAT compression PMD can be tested by running the test application::
 485
 486     make defconfig
 487     sed -i 's,\(CONFIG_RTE_COMPRESSDEV_TEST\)=n,\1=y,' build/.config
 488     make test-build -j
 489     cd ./build/app
 490     ./test -l1 -n1 -w <your qat bdf>
 491     RTE>>compressdev_autotest
 492
 493
 494 Debugging
 495 ~~~~~~~~~
 496
 497 There are 2 sets of trace available via the dynamic logging feature:
 498
 499 * pmd.qat_dp exposes trace on the data-path.
 500 * pmd.qat_general exposes all other trace.
 501
 502 pmd.qat exposes both sets of traces.
 503 They can be enabled using the log-level option (where 8=maximum log level) on
 504 the process cmdline, e.g. using any of the following::
 505
 506     --log-level="pmd.qat_general,8"
 507     --log-level="pmd.qat_dp,8"
 508     --log-level="pmd.qat,8"
 509
 510 .. Note::
 511
 512     The global RTE_LOG_DP_LEVEL overrides data-path trace so must be set to
 513     RTE_LOG_DEBUG to see all the trace. This variable is in config/rte_config.h
 514     for meson build and config/common_base for gnu make.
 515     Also the dynamic global log level overrides both sets of trace, so e.g. no
 516     QAT trace would display in this case::
 517
 518         --log-level="7" --log-level="pmd.qat_general,8"