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