2 Copyright(c) 2015-2016 Intel Corporation. All rights reserved.
4 Redistribution and use in source and binary forms, with or without
5 modification, are permitted provided that the following conditions
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
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.
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.
30 Intel(R) QuickAssist (QAT) Crypto Poll Mode Driver
31 ==================================================
33 The QAT PMD provides poll mode crypto driver support for the following
34 hardware accelerator devices:
36 * ``Intel QuickAssist Technology DH895xCC``
37 * ``Intel QuickAssist Technology C62x``
38 * ``Intel QuickAssist Technology C3xxx``
39 * ``Intel QuickAssist Technology D15xx``
45 The QAT PMD has support for:
49 * ``RTE_CRYPTO_CIPHER_3DES_CBC``
50 * ``RTE_CRYPTO_CIPHER_3DES_CTR``
51 * ``RTE_CRYPTO_CIPHER_AES128_CBC``
52 * ``RTE_CRYPTO_CIPHER_AES192_CBC``
53 * ``RTE_CRYPTO_CIPHER_AES256_CBC``
54 * ``RTE_CRYPTO_CIPHER_AES128_CTR``
55 * ``RTE_CRYPTO_CIPHER_AES192_CTR``
56 * ``RTE_CRYPTO_CIPHER_AES256_CTR``
57 * ``RTE_CRYPTO_CIPHER_SNOW3G_UEA2``
58 * ``RTE_CRYPTO_CIPHER_NULL``
59 * ``RTE_CRYPTO_CIPHER_KASUMI_F8``
60 * ``RTE_CRYPTO_CIPHER_DES_CBC``
61 * ``RTE_CRYPTO_CIPHER_AES_DOCSISBPI``
62 * ``RTE_CRYPTO_CIPHER_DES_DOCSISBPI``
63 * ``RTE_CRYPTO_CIPHER_ZUC_EEA3``
67 * ``RTE_CRYPTO_AUTH_SHA1_HMAC``
68 * ``RTE_CRYPTO_AUTH_SHA224_HMAC``
69 * ``RTE_CRYPTO_AUTH_SHA256_HMAC``
70 * ``RTE_CRYPTO_AUTH_SHA384_HMAC``
71 * ``RTE_CRYPTO_AUTH_SHA512_HMAC``
72 * ``RTE_CRYPTO_AUTH_AES_XCBC_MAC``
73 * ``RTE_CRYPTO_AUTH_SNOW3G_UIA2``
74 * ``RTE_CRYPTO_AUTH_MD5_HMAC``
75 * ``RTE_CRYPTO_AUTH_NULL``
76 * ``RTE_CRYPTO_AUTH_KASUMI_F9``
77 * ``RTE_CRYPTO_AUTH_AES_GMAC``
78 * ``RTE_CRYPTO_AUTH_ZUC_EIA3``
80 Supported AEAD algorithms:
82 * ``RTE_CRYPTO_AEAD_AES_GCM``
88 * Only supports the session-oriented API implementation (session-less APIs are not supported).
89 * SNOW 3G (UEA2), KASUMI (F8) and ZUC (EEA3) supported only if cipher length and offset fields are byte-multiple.
90 * SNOW 3G (UIA2) and ZUC (EIA3) supported only if hash length and offset fields are byte-multiple.
91 * No BSD support as BSD QAT kernel driver not available.
92 * ZUC EEA3/EIA3 is not supported by dh895xcc devices
93 * Maximum additional authenticated data (AAD) for GCM is 240 bytes long.
94 * Queue pairs are not thread-safe (that is, within a single queue pair, RX and TX from different lcores is not supported).
100 To enable QAT in DPDK, follow the instructions for modifying the compile-time
101 configuration file as described `here <http://dpdk.org/doc/guides/linux_gsg/build_dpdk.html>`_.
103 Quick instructions are as follows:
105 .. code-block:: console
107 cd to the top-level DPDK directory
108 make config T=x86_64-native-linuxapp-gcc
109 sed -i 's,\(CONFIG_RTE_LIBRTE_PMD_QAT\)=n,\1=y,' build/.config
112 To use the DPDK QAT PMD an SRIOV-enabled QAT kernel driver is required. The VF
113 devices exposed by this driver will be used by the QAT PMD. The devices and
114 available kernel drivers and device ids are :
116 .. _table_qat_pmds_drivers:
118 .. table:: QAT device generations, devices and drivers
120 +-----+----------+--------+---------------+------------+--------+------+--------+--------+
121 | Gen | Device | Driver | Kernel Module | Pci Driver | PF Did | #PFs | Vf Did | VFs/PF |
122 +=====+==========+========+===============+============+========+======+========+========+
123 | 1 | DH895xCC | 01.org | icp_qa_al | n/a | 435 | 1 | 443 | 32 |
124 +-----+----------+--------+---------------+------------+--------+------+--------+--------+
125 | 1 | DH895xCC | 4.4+ | qat_dh895xcc | dh895xcc | 435 | 1 | 443 | 32 |
126 +-----+----------+--------+---------------+------------+--------+------+--------+--------+
127 | 2 | C62x | 4.5+ | qat_c62x | c6xx | 37c8 | 3 | 37c9 | 16 |
128 +-----+----------+--------+---------------+------------+--------+------+--------+--------+
129 | 2 | C3xxx | 4.5+ | qat_c3xxx | c3xxx | 19e2 | 1 | 19e3 | 16 |
130 +-----+----------+--------+---------------+------------+--------+------+--------+--------+
131 | 2 | D15xx | p | qat_d15xx | d15xx | 6f54 | 1 | 6f55 | 16 |
132 +-----+----------+--------+---------------+------------+--------+------+--------+--------+
135 The ``Driver`` column indicates either the Linux kernel version in which
136 support for this device was introduced or a driver available on Intel's 01.org
137 website. There are both linux and 01.org kernel drivers available for some
138 devices. p = release pending.
140 If you are running on a kernel which includes a driver for your device, see
141 `Installation using kernel.org driver`_ below. Otherwise see
142 `Installation using 01.org QAT driver`_.
145 Installation using kernel.org driver
146 ------------------------------------
148 The examples below are based on the C62x device, if you have a different device
149 use the corresponding values in the above table.
151 In BIOS ensure that SRIOV is enabled and either:
154 * Enable VT-d and set ``"intel_iommu=on iommu=pt"`` in the grub file.
156 Check that the QAT driver is loaded on your system, by executing::
160 You should see the kernel module for your device listed, e.g.::
163 intel_qat 82336 1 qat_c62x
165 Next, you need to expose the Virtual Functions (VFs) using the sysfs file system.
167 First find the BDFs (Bus-Device-Function) of the physical functions (PFs) of
172 You should see output similar to::
174 1a:00.0 Co-processor: Intel Corporation Device 37c8
175 3d:00.0 Co-processor: Intel Corporation Device 37c8
176 3f:00.0 Co-processor: Intel Corporation Device 37c8
178 Enable the VFs for each PF by echoing the number of VFs per PF to the pci driver::
180 echo 16 > /sys/bus/pci/drivers/c6xx/0000:1a:00.0/sriov_numvfs
181 echo 16 > /sys/bus/pci/drivers/c6xx/0000:3d:00.0/sriov_numvfs
182 echo 16 > /sys/bus/pci/drivers/c6xx/0000:3f:00.0/sriov_numvfs
184 Check that the VFs are available for use. For example ``lspci -d:37c9`` should
185 list 48 VF devices available for a ``C62x`` device.
187 To complete the installation follow the instructions in
188 `Binding the available VFs to the DPDK UIO driver`_.
192 If the QAT kernel modules are not loaded and you see an error like ``Failed
193 to load MMP firmware qat_895xcc_mmp.bin`` in kernel logs, this may be as a
194 result of not using a distribution, but just updating the kernel directly.
196 Download firmware from the `kernel firmware repo
197 <http://git.kernel.org/cgit/linux/kernel/git/firmware/linux-firmware.git/tree/>`_.
199 Copy qat binaries to ``/lib/firmware``::
201 cp qat_895xcc.bin /lib/firmware
202 cp qat_895xcc_mmp.bin /lib/firmware
204 Change to your linux source root directory and start the qat kernel modules::
206 insmod ./drivers/crypto/qat/qat_common/intel_qat.ko
207 insmod ./drivers/crypto/qat/qat_dh895xcc/qat_dh895xcc.ko
212 If you see the following warning in ``/var/log/messages`` it can be ignored:
213 ``IOMMU should be enabled for SR-IOV to work correctly``.
216 Installation using 01.org QAT driver
217 ------------------------------------
219 Download the latest QuickAssist Technology Driver from `01.org
220 <https://01.org/packet-processing/intel%C2%AE-quickassist-technology-drivers-and-patches>`_.
221 Consult the *Getting Started Guide* at the same URL for further information.
223 The steps below assume you are:
225 * Building on a platform with one ``DH895xCC`` device.
226 * Using package ``qatmux.l.2.3.0-34.tgz``.
227 * On Fedora21 kernel ``3.17.4-301.fc21.x86_64``.
229 In the BIOS ensure that SRIOV is enabled and VT-d is disabled.
231 Uninstall any existing QAT driver, for example by running:
233 * ``./installer.sh uninstall`` in the directory where originally installed.
235 * or ``rmmod qat_dh895xcc; rmmod intel_qat``.
237 Build and install the SRIOV-enabled QAT driver::
242 # Copy qatmux.l.2.3.0-34.tgz to this location
243 tar zxof qatmux.l.2.3.0-34.tgz
245 export ICP_WITHOUT_IOMMU=1
246 ./installer.sh install QAT1.6 host
248 You can use ``cat /proc/icp_dh895xcc_dev0/version`` to confirm the driver is correctly installed.
249 You can use ``lspci -d:443`` to confirm the of the 32 VF devices available per ``DH895xCC`` device.
251 To complete the installation - follow instructions in `Binding the available VFs to the DPDK UIO driver`_.
255 If using a later kernel and the build fails with an error relating to
256 ``strict_stroul`` not being available apply the following patch:
260 /QAT/QAT1.6/quickassist/utilities/downloader/Target_CoreLibs/uclo/include/linux/uclo_platform.h
261 + #if LINUX_VERSION_CODE >= KERNEL_VERSION(3,18,5)
262 + #define STR_TO_64(str, base, num, endPtr) {endPtr=NULL; if (kstrtoul((str), (base), (num))) printk("Error strtoull convert %s\n", str); }
264 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,38)
265 #define STR_TO_64(str, base, num, endPtr) {endPtr=NULL; if (strict_strtoull((str), (base), (num))) printk("Error strtoull convert %s\n", str); }
267 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,25)
268 #define STR_TO_64(str, base, num, endPtr) {endPtr=NULL; strict_strtoll((str), (base), (num));}
270 #define STR_TO_64(str, base, num, endPtr) \
274 *(num) = -(simple_strtoull((str+1), &(endPtr), (base))); \
276 *(num) = simple_strtoull((str), &(endPtr), (base)); \
286 If the build fails due to missing header files you may need to do following::
288 sudo yum install zlib-devel
289 sudo yum install openssl-devel
293 If the build or install fails due to mismatching kernel sources you may need to do the following::
295 sudo yum install kernel-headers-`uname -r`
296 sudo yum install kernel-src-`uname -r`
297 sudo yum install kernel-devel-`uname -r`
300 Binding the available VFs to the DPDK UIO driver
301 ------------------------------------------------
303 Unbind the VFs from the stock driver so they can be bound to the uio driver.
305 For an Intel(R) QuickAssist Technology DH895xCC device
306 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
308 The unbind command below assumes ``BDFs`` of ``03:01.00-03:04.07``, if your
309 VFs are different adjust the unbind command below::
311 for device in $(seq 1 4); do \
312 for fn in $(seq 0 7); do \
313 echo -n 0000:03:0${device}.${fn} > \
314 /sys/bus/pci/devices/0000\:03\:0${device}.${fn}/driver/unbind; \
318 For an Intel(R) QuickAssist Technology C62x device
319 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
321 The unbind command below assumes ``BDFs`` of ``1a:01.00-1a:02.07``,
322 ``3d:01.00-3d:02.07`` and ``3f:01.00-3f:02.07``, if your VFs are different
323 adjust the unbind command below::
325 for device in $(seq 1 2); do \
326 for fn in $(seq 0 7); do \
327 echo -n 0000:1a:0${device}.${fn} > \
328 /sys/bus/pci/devices/0000\:1a\:0${device}.${fn}/driver/unbind; \
330 echo -n 0000:3d:0${device}.${fn} > \
331 /sys/bus/pci/devices/0000\:3d\:0${device}.${fn}/driver/unbind; \
333 echo -n 0000:3f:0${device}.${fn} > \
334 /sys/bus/pci/devices/0000\:3f\:0${device}.${fn}/driver/unbind; \
338 For Intel(R) QuickAssist Technology C3xxx or D15xx device
339 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
341 The unbind command below assumes ``BDFs`` of ``01:01.00-01:02.07``, if your
342 VFs are different adjust the unbind command below::
344 for device in $(seq 1 2); do \
345 for fn in $(seq 0 7); do \
346 echo -n 0000:01:0${device}.${fn} > \
347 /sys/bus/pci/devices/0000\:01\:0${device}.${fn}/driver/unbind; \
351 Bind to the DPDK uio driver
352 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
354 Install the DPDK igb_uio driver, bind the VF PCI Device id to it and use lspci
355 to confirm the VF devices are now in use by igb_uio kernel driver,
356 e.g. for the C62x device::
358 cd to the top-level DPDK directory
360 insmod ./build/kmod/igb_uio.ko
361 echo "8086 37c9" > /sys/bus/pci/drivers/igb_uio/new_id
365 Another way to bind the VFs to the DPDK UIO driver is by using the
366 ``dpdk-devbind.py`` script::
368 cd to the top-level DPDK directory
369 ./usertools/dpdk-devbind.py -b igb_uio 0000:03:01.1
372 Extra notes on KASUMI F9
373 ------------------------
375 When using KASUMI F9 authentication algorithm, the input buffer must be
376 constructed according to the 3GPP KASUMI specifications (section 4.4, page 13):
377 `<http://cryptome.org/3gpp/35201-900.pdf>`_.
378 Input buffer has to have COUNT (4 bytes), FRESH (4 bytes), MESSAGE and DIRECTION (1 bit)
379 concatenated. After the DIRECTION bit, a single '1' bit is appended, followed by
380 between 0 and 7 '0' bits, so that the total length of the buffer is multiple of 8 bits.
381 Note that the actual message can be any length, specified in bits.
383 Once this buffer is passed this way, when creating the crypto operation,
384 length of data to authenticate (op.sym.auth.data.length) must be the length
385 of all the items described above, including the padding at the end.
386 Also, offset of data to authenticate (op.sym.auth.data.offset)
387 must be such that points at the start of the COUNT bytes.