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