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