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