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 Quick Assist Crypto Poll Mode Driver
  31 ====================================
  32
  33 The QAT PMD provides poll mode crypto driver support for **Intel QuickAssist
  34 Technology DH895xxC** hardware accelerator.
  35
  36
  37 Features
  38 --------
  39
  40 The QAT PMD has support for:
  41
  42 Cipher algorithms:
  43
  44 * ``RTE_CRYPTO_SYM_CIPHER_AES128_CBC``
  45 * ``RTE_CRYPTO_SYM_CIPHER_AES192_CBC``
  46 * ``RTE_CRYPTO_SYM_CIPHER_AES256_CBC``
  47 * ``RTE_CRYPTO_SYM_CIPHER_AES128_CTR``
  48 * ``RTE_CRYPTO_SYM_CIPHER_AES192_CTR``
  49 * ``RTE_CRYPTO_SYM_CIPHER_AES256_CTR``
  50 * ``RTE_CRYPTO_SYM_CIPHER_SNOW3G_UEA2``
  51 * ``RTE_CRYPTO_CIPHER_AES_GCM``
  52
  53 Hash algorithms:
  54
  55 * ``RTE_CRYPTO_AUTH_SHA1_HMAC``
  56 * ``RTE_CRYPTO_AUTH_SHA256_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
  62
  63 Limitations
  64 -----------
  65
  66 * Chained mbufs are not supported.
  67 * Hash only is not supported except Snow3G UIA2.
  68 * Cipher only is not supported except Snow3G UEA2.
  69 * Only supports the session-oriented API implementation (session-less APIs are not supported).
  70 * Not performance tuned.
  71 * Snow3g(UEA2) supported only if cipher length, cipher offset fields are byte-aligned.
  72 * Snow3g(UIA2) supported only if hash length, hash offset fields are byte-aligned.
  73 * No BSD support as BSD QAT kernel driver not available.
  74
  75
  76 Installation
  77 ------------
  78
  79 To use the DPDK QAT PMD an SRIOV-enabled QAT kernel driver is required. The
  80 VF devices exposed by this driver will be used by QAT PMD.
  81
  82 If you are running on kernel 4.4 or greater, see instructions for
  83 `Installation using kernel.org driver`_ below. If you are on a kernel earlier
  84 than 4.4, see `Installation using 01.org QAT driver`_.
  85
  86
  87 Installation using 01.org QAT driver
  88 ------------------------------------
  89
  90 Download the latest QuickAssist Technology Driver from `01.org
  91 <https://01.org/packet-processing/intel%C2%AE-quickassist-technology-drivers-and-patches>`_
  92 Consult the *Getting Started Guide* at the same URL for further information.
  93
  94 The steps below assume you are:
  95
  96 * Building on a platform with one ``DH895xCC`` device.
  97 * Using package ``qatmux.l.2.3.0-34.tgz``.
  98 * On Fedora21 kernel ``3.17.4-301.fc21.x86_64``.
  99
 100 In the BIOS ensure that SRIOV is enabled and VT-d is disabled.
 101
 102 Uninstall any existing QAT driver, for example by running:
 103
 104 * ``./installer.sh uninstall`` in the directory where originally installed.
 105
 106 * or ``rmmod qat_dh895xcc; rmmod intel_qat``.
 107
 108 Build and install the SRIOV-enabled QAT driver::
 109
 110     mkdir /QAT
 111     cd /QAT
 112     # copy qatmux.l.2.3.0-34.tgz to this location
 113     tar zxof qatmux.l.2.3.0-34.tgz
 114
 115     export ICP_WITHOUT_IOMMU=1
 116     ./installer.sh install QAT1.6 host
 117
 118 You can use ``cat /proc/icp_dh895xcc_dev0/version`` to confirm the driver is correctly installed.
 119 You can use ``lspci -d:443`` to confirm the bdf of the 32 VF devices are available per ``DH895xCC`` device.
 120
 121 To complete the installation - follow instructions in `Binding the available VFs to the DPDK UIO driver`_.
 122
 123 **Note**: If using a later kernel and the build fails with an error relating to ``strict_stroul`` not being available apply the following patch:
 124
 125 .. code-block:: diff
 126
 127    /QAT/QAT1.6/quickassist/utilities/downloader/Target_CoreLibs/uclo/include/linux/uclo_platform.h
 128    + #if LINUX_VERSION_CODE >= KERNEL_VERSION(3,18,5)
 129    + #define STR_TO_64(str, base, num, endPtr) {endPtr=NULL; if (kstrtoul((str), (base), (num))) printk("Error strtoull convert %s\n", str); }
 130    + #else
 131    #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,38)
 132    #define STR_TO_64(str, base, num, endPtr) {endPtr=NULL; if (strict_strtoull((str), (base), (num))) printk("Error strtoull convert %s\n", str); }
 133    #else
 134    #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,25)
 135    #define STR_TO_64(str, base, num, endPtr) {endPtr=NULL; strict_strtoll((str), (base), (num));}
 136    #else
 137    #define STR_TO_64(str, base, num, endPtr)                                 \
 138         do {                                                               \
 139               if (str[0] == '-')                                           \
 140               {                                                            \
 141                    *(num) = -(simple_strtoull((str+1), &(endPtr), (base))); \
 142               }else {                                                      \
 143                    *(num) = simple_strtoull((str), &(endPtr), (base));      \
 144               }                                                            \
 145         } while(0)
 146    + #endif
 147    #endif
 148    #endif
 149
 150
 151 If the build fails due to missing header files you may need to do following:
 152
 153 * ``sudo yum install zlib-devel``
 154 * ``sudo yum install openssl-devel``
 155
 156 If the build or install fails due to mismatching kernel sources you may need to do the following:
 157
 158 * ``sudo yum install kernel-headers-`uname -r```
 159 * ``sudo yum install kernel-src-`uname -r```
 160 * ``sudo yum install kernel-devel-`uname -r```
 161
 162
 163 Installation using kernel.org driver
 164 ------------------------------------
 165
 166 Assuming you are running on at least a 4.4 kernel, you can use the stock kernel.org QAT
 167 driver to start the QAT hardware.
 168
 169 The steps below assume you are:
 170
 171 * Running DPDK on a platform with one ``DH895xCC`` device.
 172 * On a kernel at least version 4.4.
 173
 174 In BIOS ensure that SRIOV is enabled and VT-d is disabled.
 175
 176 Ensure the QAT driver is loaded on your system, by executing::
 177
 178     lsmod | grep qat
 179
 180 You should see the following output::
 181
 182     qat_dh895xcc            5626  0
 183     intel_qat              82336  1 qat_dh895xcc
 184
 185 Next, you need to expose the VFs using the sysfs file system.
 186
 187 First find the bdf of the DH895xCC device::
 188
 189     lspci -d : 435
 190
 191 You should see output similar to::
 192
 193     03:00.0 Co-processor: Intel Corporation Coleto Creek PCIe Endpoint
 194
 195 Using the sysfs, enable the VFs::
 196
 197     echo 32 > /sys/bus/pci/drivers/dh895xcc/0000\:03\:00.0/sriov_numvfs
 198
 199 If you get an error, it's likely you're using a QAT kernel driver earlier than kernel 4.4.
 200
 201 To verify that the VFs are available for use - use ``lspci -d:443`` to confirm
 202 the bdf of the 32 VF devices are available per ``DH895xCC`` device.
 203
 204 To complete the installation - follow instructions in `Binding the available VFs to the DPDK UIO driver`_.
 205
 206 **Note**: If the QAT kernel modules are not loaded and you see an error like
 207     ``Failed to load MMP firmware qat_895xcc_mmp.bin`` this may be as a
 208     result of not using a distribution, but just updating the kernel directly.
 209
 210 Download firmware from the kernel firmware repo at:
 211 http://git.kernel.org/cgit/linux/kernel/git/firmware/linux-firmware.git/tree/
 212
 213 Copy qat binaries to /lib/firmware:
 214 *    ``cp qat_895xcc.bin /lib/firmware``
 215 *    ``cp qat_895xcc_mmp.bin /lib/firmware``
 216
 217 cd to your linux source root directory and start the qat kernel modules:
 218 *    ``insmod ./drivers/crypto/qat/qat_common/intel_qat.ko``
 219 *    ``insmod ./drivers/crypto/qat/qat_dh895xcc/qat_dh895xcc.ko``
 220
 221 **Note**:The following warning in /var/log/messages can be ignored:
 222     ``IOMMU should be enabled for SR-IOV to work correctly``
 223
 224
 225
 226 Binding the available VFs to the DPDK UIO driver
 227 ------------------------------------------------
 228
 229 The unbind command below assumes ``bdfs`` of ``03:01.00-03:04.07``, if yours are different adjust the unbind command below::
 230
 231    cd $RTE_SDK
 232    modprobe uio
 233    insmod ./build/kmod/igb_uio.ko
 234
 235    for device in $(seq 1 4); do \
 236        for fn in $(seq 0 7); do \
 237            echo -n 0000:03:0${device}.${fn} > \
 238            /sys/bus/pci/devices/0000\:03\:0${device}.${fn}/driver/unbind; \
 239        done; \
 240    done
 241
 242    echo "8086 0443" > /sys/bus/pci/drivers/igb_uio/new_id
 243
 244 You can use ``lspci -vvd:443`` to confirm that all devices are now in use by igb_uio kernel driver.