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