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