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:
81 * ``RTE_CRYPTO_AEAD_AES_GCM``
87 * Only supports the session-oriented API implementation (session-less APIs are not supported).
88 * SNOW 3G (UEA2), KASUMI (F8) and ZUC (EEA3) supported only if cipher length and offset fields are byte-multiple.
89 * SNOW 3G (UIA2) and ZUC (EIA3) supported only if hash length and offset fields are byte-multiple.
90 * No BSD support as BSD QAT kernel driver not available.
91 * ZUC EEA3/EIA3 is not supported by dh895xcc devices
92 * Maximum additional authenticated data (AAD) for GCM is 240 bytes long.
93 * Queue pairs are not thread-safe (that is, within a single queue pair, RX and TX from different lcores is not supported).
99 To enable QAT in DPDK, follow the instructions for modifying the compile-time
100 configuration file as described `here <http://dpdk.org/doc/guides/linux_gsg/build_dpdk.html>`_.
102 Quick instructions are as follows:
104 .. code-block:: console
106 cd to the top-level DPDK directory
107 make config T=x86_64-native-linuxapp-gcc
108 sed -i 's,\(CONFIG_RTE_LIBRTE_PMD_QAT\)=n,\1=y,' build/.config
111 To use the DPDK QAT PMD an SRIOV-enabled QAT kernel driver is required. The VF
112 devices exposed by this driver will be used by the QAT PMD. The devices and
113 available kernel drivers and device ids are :
115 .. _table_qat_pmds_drivers:
117 .. table:: QAT device generations, devices and drivers
119 +-----+----------+--------+---------------+------------+--------+------+--------+--------+
120 | Gen | Device | Driver | Kernel Module | Pci Driver | PF Did | #PFs | Vf Did | VFs/PF |
121 +=====+==========+========+===============+============+========+======+========+========+
122 | 1 | DH895xCC | 01.org | icp_qa_al | n/a | 435 | 1 | 443 | 32 |
123 +-----+----------+--------+---------------+------------+--------+------+--------+--------+
124 | 1 | DH895xCC | 4.4+ | qat_dh895xcc | dh895xcc | 435 | 1 | 443 | 32 |
125 +-----+----------+--------+---------------+------------+--------+------+--------+--------+
126 | 2 | C62x | 4.5+ | qat_c62x | c6xx | 37c8 | 3 | 37c9 | 16 |
127 +-----+----------+--------+---------------+------------+--------+------+--------+--------+
128 | 2 | C3xxx | 4.5+ | qat_c3xxx | c3xxx | 19e2 | 1 | 19e3 | 16 |
129 +-----+----------+--------+---------------+------------+--------+------+--------+--------+
130 | 2 | D15xx | p | qat_d15xx | d15xx | 6f54 | 1 | 6f55 | 16 |
131 +-----+----------+--------+---------------+------------+--------+------+--------+--------+
134 The ``Driver`` column indicates either the Linux kernel version in which
135 support for this device was introduced or a driver available on Intel's 01.org
136 website. There are both linux and 01.org kernel drivers available for some
137 devices. p = release pending.
139 If you are running on a kernel which includes a driver for your device, see
140 `Installation using kernel.org driver`_ below. Otherwise see
141 `Installation using 01.org QAT driver`_.
144 Installation using kernel.org driver
145 ------------------------------------
147 The examples below are based on the C62x device, if you have a different device
148 use the corresponding values in the above table.
150 In BIOS ensure that SRIOV is enabled and either:
153 * Enable VT-d and set ``"intel_iommu=on iommu=pt"`` in the grub file.
155 Check that the QAT driver is loaded on your system, by executing::
159 You should see the kernel module for your device listed, e.g.::
162 intel_qat 82336 1 qat_c62x
164 Next, you need to expose the Virtual Functions (VFs) using the sysfs file system.
166 First find the BDFs (Bus-Device-Function) of the physical functions (PFs) of
171 You should see output similar to::
173 1a:00.0 Co-processor: Intel Corporation Device 37c8
174 3d:00.0 Co-processor: Intel Corporation Device 37c8
175 3f:00.0 Co-processor: Intel Corporation Device 37c8
177 Enable the VFs for each PF by echoing the number of VFs per PF to the pci driver::
179 echo 16 > /sys/bus/pci/drivers/c6xx/0000:1a:00.0/sriov_numvfs
180 echo 16 > /sys/bus/pci/drivers/c6xx/0000:3d:00.0/sriov_numvfs
181 echo 16 > /sys/bus/pci/drivers/c6xx/0000:3f:00.0/sriov_numvfs
183 Check that the VFs are available for use. For example ``lspci -d:37c9`` should
184 list 48 VF devices available for a ``C62x`` device.
186 To complete the installation follow the instructions in
187 `Binding the available VFs to the DPDK UIO driver`_.
191 If the QAT kernel modules are not loaded and you see an error like ``Failed
192 to load MMP firmware qat_895xcc_mmp.bin`` in kernel logs, this may be as a
193 result of not using a distribution, but just updating the kernel directly.
195 Download firmware from the `kernel firmware repo
196 <http://git.kernel.org/cgit/linux/kernel/git/firmware/linux-firmware.git/tree/>`_.
198 Copy qat binaries to ``/lib/firmware``::
200 cp qat_895xcc.bin /lib/firmware
201 cp qat_895xcc_mmp.bin /lib/firmware
203 Change to your linux source root directory and start the qat kernel modules::
205 insmod ./drivers/crypto/qat/qat_common/intel_qat.ko
206 insmod ./drivers/crypto/qat/qat_dh895xcc/qat_dh895xcc.ko
211 If you see the following warning in ``/var/log/messages`` it can be ignored:
212 ``IOMMU should be enabled for SR-IOV to work correctly``.
215 Installation using 01.org QAT driver
216 ------------------------------------
218 Download the latest QuickAssist Technology Driver from `01.org
219 <https://01.org/packet-processing/intel%C2%AE-quickassist-technology-drivers-and-patches>`_.
220 Consult the *Getting Started Guide* at the same URL for further information.
222 The steps below assume you are:
224 * Building on a platform with one ``DH895xCC`` device.
225 * Using package ``qatmux.l.2.3.0-34.tgz``.
226 * On Fedora21 kernel ``3.17.4-301.fc21.x86_64``.
228 In the BIOS ensure that SRIOV is enabled and VT-d is disabled.
230 Uninstall any existing QAT driver, for example by running:
232 * ``./installer.sh uninstall`` in the directory where originally installed.
234 * or ``rmmod qat_dh895xcc; rmmod intel_qat``.
236 Build and install the SRIOV-enabled QAT driver::
241 # Copy qatmux.l.2.3.0-34.tgz to this location
242 tar zxof qatmux.l.2.3.0-34.tgz
244 export ICP_WITHOUT_IOMMU=1
245 ./installer.sh install QAT1.6 host
247 You can use ``cat /proc/icp_dh895xcc_dev0/version`` to confirm the driver is correctly installed.
248 You can use ``lspci -d:443`` to confirm the of the 32 VF devices available per ``DH895xCC`` device.
250 To complete the installation - follow instructions in `Binding the available VFs to the DPDK UIO driver`_.
254 If using a later kernel and the build fails with an error relating to
255 ``strict_stroul`` not being available apply the following patch:
259 /QAT/QAT1.6/quickassist/utilities/downloader/Target_CoreLibs/uclo/include/linux/uclo_platform.h
260 + #if LINUX_VERSION_CODE >= KERNEL_VERSION(3,18,5)
261 + #define STR_TO_64(str, base, num, endPtr) {endPtr=NULL; if (kstrtoul((str), (base), (num))) printk("Error strtoull convert %s\n", str); }
263 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,38)
264 #define STR_TO_64(str, base, num, endPtr) {endPtr=NULL; if (strict_strtoull((str), (base), (num))) printk("Error strtoull convert %s\n", str); }
266 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,25)
267 #define STR_TO_64(str, base, num, endPtr) {endPtr=NULL; strict_strtoll((str), (base), (num));}
269 #define STR_TO_64(str, base, num, endPtr) \
273 *(num) = -(simple_strtoull((str+1), &(endPtr), (base))); \
275 *(num) = simple_strtoull((str), &(endPtr), (base)); \
285 If the build fails due to missing header files you may need to do following::
287 sudo yum install zlib-devel
288 sudo yum install openssl-devel
292 If the build or install fails due to mismatching kernel sources you may need to do the following::
294 sudo yum install kernel-headers-`uname -r`
295 sudo yum install kernel-src-`uname -r`
296 sudo yum install kernel-devel-`uname -r`
299 Binding the available VFs to the DPDK UIO driver
300 ------------------------------------------------
302 Unbind the VFs from the stock driver so they can be bound to the uio driver.
304 For an Intel(R) QuickAssist Technology DH895xCC device
305 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
307 The unbind command below assumes ``BDFs`` of ``03:01.00-03:04.07``, if your
308 VFs are different adjust the unbind command below::
310 for device in $(seq 1 4); do \
311 for fn in $(seq 0 7); do \
312 echo -n 0000:03:0${device}.${fn} > \
313 /sys/bus/pci/devices/0000\:03\:0${device}.${fn}/driver/unbind; \
317 For an Intel(R) QuickAssist Technology C62x device
318 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
320 The unbind command below assumes ``BDFs`` of ``1a:01.00-1a:02.07``,
321 ``3d:01.00-3d:02.07`` and ``3f:01.00-3f:02.07``, if your VFs are different
322 adjust the unbind command below::
324 for device in $(seq 1 2); do \
325 for fn in $(seq 0 7); do \
326 echo -n 0000:1a:0${device}.${fn} > \
327 /sys/bus/pci/devices/0000\:1a\:0${device}.${fn}/driver/unbind; \
329 echo -n 0000:3d:0${device}.${fn} > \
330 /sys/bus/pci/devices/0000\:3d\:0${device}.${fn}/driver/unbind; \
332 echo -n 0000:3f:0${device}.${fn} > \
333 /sys/bus/pci/devices/0000\:3f\:0${device}.${fn}/driver/unbind; \
337 For Intel(R) QuickAssist Technology C3xxx or D15xx device
338 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
340 The unbind command below assumes ``BDFs`` of ``01:01.00-01:02.07``, if your
341 VFs are different adjust the unbind command below::
343 for device in $(seq 1 2); do \
344 for fn in $(seq 0 7); do \
345 echo -n 0000:01:0${device}.${fn} > \
346 /sys/bus/pci/devices/0000\:01\:0${device}.${fn}/driver/unbind; \
350 Bind to the DPDK uio driver
351 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
353 Install the DPDK igb_uio driver, bind the VF PCI Device id to it and use lspci
354 to confirm the VF devices are now in use by igb_uio kernel driver,
355 e.g. for the C62x device::
357 cd to the top-level DPDK directory
359 insmod ./build/kmod/igb_uio.ko
360 echo "8086 37c9" > /sys/bus/pci/drivers/igb_uio/new_id
364 Another way to bind the VFs to the DPDK UIO driver is by using the
365 ``dpdk-devbind.py`` script::
367 cd to the top-level DPDK directory
368 ./usertools/dpdk-devbind.py -b igb_uio 0000:03:01.1
371 Extra notes on KASUMI F9
372 ------------------------
374 When using KASUMI F9 authentication algorithm, the input buffer must be
375 constructed according to the 3GPP KASUMI specifications (section 4.4, page 13):
376 `<http://cryptome.org/3gpp/35201-900.pdf>`_.
377 Input buffer has to have COUNT (4 bytes), FRESH (4 bytes), MESSAGE and DIRECTION (1 bit)
378 concatenated. After the DIRECTION bit, a single '1' bit is appended, followed by
379 between 0 and 7 '0' bits, so that the total length of the buffer is multiple of 8 bits.
380 Note that the actual message can be any length, specified in bits.
382 Once this buffer is passed this way, when creating the crypto operation,
383 length of data to authenticate (op.sym.auth.data.length) must be the length
384 of all the items described above, including the padding at the end.
385 Also, offset of data to authenticate (op.sym.auth.data.offset)
386 must be such that points at the start of the COUNT bytes.