doc/guides/cryptodevs/qat.rst

   1 ..  BSD LICENSE
   2     Copyright(c) 2015-2016 Intel Corporation. All rights reserved.
   3
   4     Redistribution and use in source and binary forms, with or without
   5     modification, are permitted provided that the following conditions
   6     are met:
   7
   8     * Redistributions of source code must retain the above copyright
   9     notice, this list of conditions and the following disclaimer.
  10     * Redistributions in binary form must reproduce the above copyright
  11     notice, this list of conditions and the following disclaimer in
  12     the documentation and/or other materials provided with the
  13     distribution.
  14     * Neither the name of Intel Corporation nor the names of its
  15     contributors may be used to endorse or promote products derived
  16     from this software without specific prior written permission.
  17
  18     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19     "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20     LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21     A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22     OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24     LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25     DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26     THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29
  30 Intel(R) QuickAssist (QAT) Crypto Poll Mode Driver
  31 ==================================================
  32
  33 The QAT PMD provides poll mode crypto driver support for **Intel QuickAssist
  34 Technology DH895xxC**, **Intel QuickAssist Technology C62x** and
  35 **Intel QuickAssist Technology C3xxx** hardware accelerator.
  36
  37
  38 Features
  39 --------
  40
  41 The QAT PMD has support for:
  42
  43 Cipher algorithms:
  44
  45 * ``RTE_CRYPTO_CIPHER_3DES_CBC``
  46 * ``RTE_CRYPTO_CIPHER_3DES_CTR``
  47 * ``RTE_CRYPTO_CIPHER_AES128_CBC``
  48 * ``RTE_CRYPTO_CIPHER_AES192_CBC``
  49 * ``RTE_CRYPTO_CIPHER_AES256_CBC``
  50 * ``RTE_CRYPTO_CIPHER_AES128_CTR``
  51 * ``RTE_CRYPTO_CIPHER_AES192_CTR``
  52 * ``RTE_CRYPTO_CIPHER_AES256_CTR``
  53 * ``RTE_CRYPTO_CIPHER_SNOW3G_UEA2``
  54 * ``RTE_CRYPTO_CIPHER_AES_GCM``
  55 * ``RTE_CRYPTO_CIPHER_NULL``
  56 * ``RTE_CRYPTO_CIPHER_KASUMI_F8``
  57 * ``RTE_CRYPTO_CIPHER_DES_CBC``
  58 * ``RTE_CRYPTO_CIPHER_AES_DOCSISBPI``
  59 * ``RTE_CRYPTO_CIPHER_DES_DOCSISBPI``
  60 * ``RTE_CRYPTO_CIPHER_ZUC_EEA3``
  61
  62 Hash algorithms:
  63
  64 * ``RTE_CRYPTO_AUTH_SHA1_HMAC``
  65 * ``RTE_CRYPTO_AUTH_SHA224_HMAC``
  66 * ``RTE_CRYPTO_AUTH_SHA256_HMAC``
  67 * ``RTE_CRYPTO_AUTH_SHA384_HMAC``
  68 * ``RTE_CRYPTO_AUTH_SHA512_HMAC``
  69 * ``RTE_CRYPTO_AUTH_AES_XCBC_MAC``
  70 * ``RTE_CRYPTO_AUTH_SNOW3G_UIA2``
  71 * ``RTE_CRYPTO_AUTH_MD5_HMAC``
  72 * ``RTE_CRYPTO_AUTH_NULL``
  73 * ``RTE_CRYPTO_AUTH_KASUMI_F9``
  74 * ``RTE_CRYPTO_AUTH_AES_GMAC``
  75 * ``RTE_CRYPTO_AUTH_ZUC_EIA3``
  76
  77
  78 Limitations
  79 -----------
  80
  81 * Hash only is not supported except SNOW 3G UIA2 and KASUMI F9.
  82 * Only supports the session-oriented API implementation (session-less APIs are not supported).
  83 * SNOW 3G (UEA2) and KASUMI (F8) supported only if cipher length, cipher offset fields are byte-aligned.
  84 * SNOW 3G (UIA2) and KASUMI (F9) supported only if hash length, hash offset fields are byte-aligned.
  85 * No BSD support as BSD QAT kernel driver not available.
  86 * ZUC EEA3/EIA3 is not supported by dh895xcc devices
  87
  88
  89 Installation
  90 ------------
  91
  92 To use the DPDK QAT PMD an SRIOV-enabled QAT kernel driver is required. The
  93 VF devices exposed by this driver will be used by QAT PMD.
  94
  95 To enable QAT in DPDK, follow the instructions mentioned in
  96 http://dpdk.org/doc/guides/linux_gsg/build_dpdk.html
  97
  98 Quick instructions as follows:
  99
 100 .. code-block:: console
 101
 102         make config T=x86_64-native-linuxapp-gcc
 103         sed -i 's,\(CONFIG_RTE_LIBRTE_PMD_QAT\)=n,\1=y,' build/.config
 104         make
 105
 106 If you are running on kernel 4.4 or greater, see instructions for
 107 `Installation using kernel.org driver`_ below. If you are on a kernel earlier
 108 than 4.4, see `Installation using 01.org QAT driver`_.
 109
 110 For **Intel QuickAssist Technology C62x** and **Intel QuickAssist Technology C3xxx**
 111 device, kernel 4.5 or greater is needed.
 112 See instructions for `Installation using kernel.org driver`_ below.
 113
 114
 115 Installation using 01.org QAT driver
 116 ------------------------------------
 117
 118 NOTE: There is no driver available for **Intel QuickAssist Technology C62x** and
 119 **Intel QuickAssist Technology C3xxx** devices on 01.org.
 120
 121 Download the latest QuickAssist Technology Driver from `01.org
 122 <https://01.org/packet-processing/intel%C2%AE-quickassist-technology-drivers-and-patches>`_
 123 Consult the *Getting Started Guide* at the same URL for further information.
 124
 125 The steps below assume you are:
 126
 127 * Building on a platform with one ``DH895xCC`` device.
 128 * Using package ``qatmux.l.2.3.0-34.tgz``.
 129 * On Fedora21 kernel ``3.17.4-301.fc21.x86_64``.
 130
 131 In the BIOS ensure that SRIOV is enabled and VT-d is disabled.
 132
 133 Uninstall any existing QAT driver, for example by running:
 134
 135 * ``./installer.sh uninstall`` in the directory where originally installed.
 136
 137 * or ``rmmod qat_dh895xcc; rmmod intel_qat``.
 138
 139 Build and install the SRIOV-enabled QAT driver::
 140
 141     mkdir /QAT
 142     cd /QAT
 143     # copy qatmux.l.2.3.0-34.tgz to this location
 144     tar zxof qatmux.l.2.3.0-34.tgz
 145
 146     export ICP_WITHOUT_IOMMU=1
 147     ./installer.sh install QAT1.6 host
 148
 149 You can use ``cat /proc/icp_dh895xcc_dev0/version`` to confirm the driver is correctly installed.
 150 You can use ``lspci -d:443`` to confirm the bdf of the 32 VF devices are available per ``DH895xCC`` device.
 151
 152 To complete the installation - follow instructions in `Binding the available VFs to the DPDK UIO driver`_.
 153
 154 **Note**: If using a later kernel and the build fails with an error relating to ``strict_stroul`` not being available apply the following patch:
 155
 156 .. code-block:: diff
 157
 158    /QAT/QAT1.6/quickassist/utilities/downloader/Target_CoreLibs/uclo/include/linux/uclo_platform.h
 159    + #if LINUX_VERSION_CODE >= KERNEL_VERSION(3,18,5)
 160    + #define STR_TO_64(str, base, num, endPtr) {endPtr=NULL; if (kstrtoul((str), (base), (num))) printk("Error strtoull convert %s\n", str); }
 161    + #else
 162    #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,38)
 163    #define STR_TO_64(str, base, num, endPtr) {endPtr=NULL; if (strict_strtoull((str), (base), (num))) printk("Error strtoull convert %s\n", str); }
 164    #else
 165    #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,25)
 166    #define STR_TO_64(str, base, num, endPtr) {endPtr=NULL; strict_strtoll((str), (base), (num));}
 167    #else
 168    #define STR_TO_64(str, base, num, endPtr)                                 \
 169         do {                                                               \
 170               if (str[0] == '-')                                           \
 171               {                                                            \
 172                    *(num) = -(simple_strtoull((str+1), &(endPtr), (base))); \
 173               }else {                                                      \
 174                    *(num) = simple_strtoull((str), &(endPtr), (base));      \
 175               }                                                            \
 176         } while(0)
 177    + #endif
 178    #endif
 179    #endif
 180
 181
 182 If the build fails due to missing header files you may need to do following:
 183
 184 * ``sudo yum install zlib-devel``
 185 * ``sudo yum install openssl-devel``
 186
 187 If the build or install fails due to mismatching kernel sources you may need to do the following:
 188
 189 * ``sudo yum install kernel-headers-`uname -r```
 190 * ``sudo yum install kernel-src-`uname -r```
 191 * ``sudo yum install kernel-devel-`uname -r```
 192
 193
 194 Installation using kernel.org driver
 195 ------------------------------------
 196
 197 For **Intel QuickAssist Technology DH895xxC**:
 198
 199 Assuming you are running on at least a 4.4 kernel, you can use the stock kernel.org QAT
 200 driver to start the QAT hardware.
 201
 202 The steps below assume you are:
 203
 204 * Running DPDK on a platform with one ``DH895xCC`` device.
 205 * On a kernel at least version 4.4.
 206
 207 In BIOS ensure that SRIOV is enabled and either
 208 a) disable VT-d or
 209 b) enable VT-d and set ``"intel_iommu=on iommu=pt"`` in the grub file.
 210
 211 Ensure the QAT driver is loaded on your system, by executing::
 212
 213     lsmod | grep qat
 214
 215 You should see the following output::
 216
 217     qat_dh895xcc            5626  0
 218     intel_qat              82336  1 qat_dh895xcc
 219
 220 Next, you need to expose the Virtual Functions (VFs) using the sysfs file system.
 221
 222 First find the bdf of the physical function (PF) of the DH895xCC device::
 223
 224     lspci -d : 435
 225
 226 You should see output similar to::
 227
 228     03:00.0 Co-processor: Intel Corporation Coleto Creek PCIe Endpoint
 229
 230 Using the sysfs, enable the VFs::
 231
 232     echo 32 > /sys/bus/pci/drivers/dh895xcc/0000\:03\:00.0/sriov_numvfs
 233
 234 If you get an error, it's likely you're using a QAT kernel driver earlier than kernel 4.4.
 235
 236 To verify that the VFs are available for use - use ``lspci -d:443`` to confirm
 237 the bdf of the 32 VF devices are available per ``DH895xCC`` device.
 238
 239 To complete the installation - follow instructions in `Binding the available VFs to the DPDK UIO driver`_.
 240
 241 **Note**: If the QAT kernel modules are not loaded and you see an error like
 242     ``Failed to load MMP firmware qat_895xcc_mmp.bin`` this may be as a
 243     result of not using a distribution, but just updating the kernel directly.
 244
 245 Download firmware from the kernel firmware repo at:
 246 http://git.kernel.org/cgit/linux/kernel/git/firmware/linux-firmware.git/tree/
 247
 248 Copy qat binaries to /lib/firmware:
 249 *    ``cp qat_895xcc.bin /lib/firmware``
 250 *    ``cp qat_895xcc_mmp.bin /lib/firmware``
 251
 252 cd to your linux source root directory and start the qat kernel modules:
 253 *    ``insmod ./drivers/crypto/qat/qat_common/intel_qat.ko``
 254 *    ``insmod ./drivers/crypto/qat/qat_dh895xcc/qat_dh895xcc.ko``
 255
 256 **Note**:The following warning in /var/log/messages can be ignored:
 257     ``IOMMU should be enabled for SR-IOV to work correctly``
 258
 259 For **Intel QuickAssist Technology C62x**:
 260 Assuming you are running on at least a 4.5 kernel, you can use the stock kernel.org QAT
 261 driver to start the QAT hardware.
 262
 263 The steps below assume you are:
 264
 265 * Running DPDK on a platform with one ``C62x`` device.
 266 * On a kernel at least version 4.5.
 267
 268 In BIOS ensure that SRIOV is enabled and either
 269 a) disable VT-d or
 270 b) enable VT-d and set ``"intel_iommu=on iommu=pt"`` in the grub file.
 271
 272 Ensure the QAT driver is loaded on your system, by executing::
 273
 274     lsmod | grep qat
 275
 276 You should see the following output::
 277
 278     qat_c62x               16384  0
 279     intel_qat             122880  1 qat_c62x
 280
 281 Next, you need to expose the VFs using the sysfs file system.
 282
 283 First find the bdf of the C62x device::
 284
 285     lspci -d:37c8
 286
 287 You should see output similar to::
 288
 289     1a:00.0 Co-processor: Intel Corporation Device 37c8
 290     3d:00.0 Co-processor: Intel Corporation Device 37c8
 291     3f:00.0 Co-processor: Intel Corporation Device 37c8
 292
 293 For each c62x device there are 3 PFs.
 294 Using the sysfs, for each PF, enable the 16 VFs::
 295
 296     echo 16 > /sys/bus/pci/drivers/c6xx/0000\:1a\:00.0/sriov_numvfs
 297
 298 If you get an error, it's likely you're using a QAT kernel driver earlier than kernel 4.5.
 299
 300 To verify that the VFs are available for use - use ``lspci -d:37c9`` to confirm
 301 the bdf of the 48 VF devices are available per ``C62x`` device.
 302
 303 To complete the installation - follow instructions in `Binding the available VFs to the DPDK UIO driver`_.
 304
 305 For **Intel QuickAssist Technology C3xxx**:
 306 Assuming you are running on at least a 4.5 kernel, you can use the stock kernel.org QAT
 307 driver to start the QAT hardware.
 308
 309 The steps below assume you are:
 310
 311 * Running DPDK on a platform with one ``C3xxx`` device.
 312 * On a kernel at least version 4.5.
 313
 314 In BIOS ensure that SRIOV is enabled and either
 315 a) disable VT-d or
 316 b) enable VT-d and set ``"intel_iommu=on iommu=pt"`` in the grub file.
 317
 318 Ensure the QAT driver is loaded on your system, by executing::
 319
 320     lsmod | grep qat
 321
 322 You should see the following output::
 323
 324     qat_c3xxx               16384  0
 325     intel_qat             122880  1 qat_c3xxx
 326
 327 Next, you need to expose the Virtual Functions (VFs) using the sysfs file system.
 328
 329 First find the bdf of the physical function (PF) of the C3xxx device
 330
 331     lspci -d:19e2
 332
 333 You should see output similar to::
 334
 335     01:00.0 Co-processor: Intel Corporation Device 19e2
 336
 337 For c3xxx device there is 1 PFs.
 338 Using the sysfs, enable the 16 VFs::
 339
 340     echo 16 > /sys/bus/pci/drivers/c3xxx/0000\:01\:00.0/sriov_numvfs
 341
 342 If you get an error, it's likely you're using a QAT kernel driver earlier than kernel 4.5.
 343
 344 To verify that the VFs are available for use - use ``lspci -d:19e3`` to confirm
 345 the bdf of the 16 VF devices are available per ``C3xxx`` device.
 346 To complete the installation - follow instructions in `Binding the available VFs to the DPDK UIO driver`_.
 347
 348 Binding the available VFs to the DPDK UIO driver
 349 ------------------------------------------------
 350
 351 For **Intel(R) QuickAssist Technology DH895xcc** device:
 352 The unbind command below assumes ``bdfs`` of ``03:01.00-03:04.07``, if yours are different adjust the unbind command below::
 353
 354    cd $RTE_SDK
 355    modprobe uio
 356    insmod ./build/kmod/igb_uio.ko
 357
 358    for device in $(seq 1 4); do \
 359        for fn in $(seq 0 7); do \
 360            echo -n 0000:03:0${device}.${fn} > \
 361            /sys/bus/pci/devices/0000\:03\:0${device}.${fn}/driver/unbind; \
 362        done; \
 363    done
 364
 365    echo "8086 0443" > /sys/bus/pci/drivers/igb_uio/new_id
 366
 367 You can use ``lspci -vvd:443`` to confirm that all devices are now in use by igb_uio kernel driver.
 368
 369 For **Intel(R) QuickAssist Technology C62x** device:
 370 The unbind command below assumes ``bdfs`` of ``1a:01.00-1a:02.07``, ``3d:01.00-3d:02.07`` and ``3f:01.00-3f:02.07``,
 371 if yours are different adjust the unbind command below::
 372
 373    cd $RTE_SDK
 374    modprobe uio
 375    insmod ./build/kmod/igb_uio.ko
 376
 377    for device in $(seq 1 2); do \
 378        for fn in $(seq 0 7); do \
 379            echo -n 0000:1a:0${device}.${fn} > \
 380            /sys/bus/pci/devices/0000\:1a\:0${device}.${fn}/driver/unbind; \
 381
 382            echo -n 0000:3d:0${device}.${fn} > \
 383            /sys/bus/pci/devices/0000\:3d\:0${device}.${fn}/driver/unbind; \
 384
 385            echo -n 0000:3f:0${device}.${fn} > \
 386            /sys/bus/pci/devices/0000\:3f\:0${device}.${fn}/driver/unbind; \
 387        done; \
 388    done
 389
 390    echo "8086 37c9" > /sys/bus/pci/drivers/igb_uio/new_id
 391
 392 You can use ``lspci -vvd:37c9`` to confirm that all devices are now in use by igb_uio kernel driver.
 393
 394 For **Intel(R) QuickAssist Technology C3xxx** device:
 395 The unbind command below assumes ``bdfs`` of ``01:01.00-01:02.07``,
 396 if yours are different adjust the unbind command below::
 397
 398    cd $RTE_SDK
 399    modprobe uio
 400    insmod ./build/kmod/igb_uio.ko
 401
 402    for device in $(seq 1 2); do \
 403        for fn in $(seq 0 7); do \
 404            echo -n 0000:01:0${device}.${fn} > \
 405            /sys/bus/pci/devices/0000\:01\:0${device}.${fn}/driver/unbind; \
 406
 407        done; \
 408    done
 409
 410    echo "8086 19e3" > /sys/bus/pci/drivers/igb_uio/new_id
 411
 412 You can use ``lspci -vvd:19e3`` to confirm that all devices are now in use by igb_uio kernel driver.
 413
 414
 415 The other way to bind the VFs to the DPDK UIO driver is by using the ``dpdk-devbind.py`` script:
 416
 417 .. code-block:: console
 418
 419     cd $RTE_SDK
 420     ./usertools/dpdk-devbind.py -b igb_uio 0000:03:01.1