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