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