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