From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by dpdk.org (Postfix) with ESMTP id 062118D91 for ; Wed, 25 Nov 2015 13:02:06 +0100 (CET) Received: from fmsmga004.fm.intel.com ([10.253.24.48]) by orsmga101.jf.intel.com with ESMTP; 25 Nov 2015 04:02:00 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.20,342,1444719600"; d="scan'208";a="2078094" Received: from irsmsx151.ger.corp.intel.com ([163.33.192.59]) by fmsmga004.fm.intel.com with ESMTP; 25 Nov 2015 04:01:59 -0800 Received: from irsmsx155.ger.corp.intel.com (163.33.192.3) by IRSMSX151.ger.corp.intel.com (163.33.192.59) with Microsoft SMTP Server (TLS) id 14.3.248.2; Wed, 25 Nov 2015 12:01:59 +0000 Received: from irsmsx103.ger.corp.intel.com ([169.254.3.13]) by irsmsx155.ger.corp.intel.com ([169.254.14.190]) with mapi id 14.03.0248.002; Wed, 25 Nov 2015 12:01:58 +0000 From: "Mcnamara, John" To: "Doherty, Declan" , "dev@dpdk.org" Thread-Topic: [dpdk-dev] [PATCH v7 07/10] qat_crypto_pmd: Addition of a new QAT DPDK PMD. Thread-Index: AQHRHkWky/nEM94g/EelVTmB0Z8+S56sptlQ Date: Wed, 25 Nov 2015 12:01:58 +0000 Message-ID: References: <1447176763-19303-1-git-send-email-declan.doherty@intel.com> <1447441090-8129-1-git-send-email-declan.doherty@intel.com> <1447441090-8129-8-git-send-email-declan.doherty@intel.com> In-Reply-To: <1447441090-8129-8-git-send-email-declan.doherty@intel.com> Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-originating-ip: [163.33.239.182] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Subject: Re: [dpdk-dev] [PATCH v7 07/10] qat_crypto_pmd: Addition of a new QAT DPDK PMD. X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 25 Nov 2015 12:02:07 -0000 > -----Original Message----- > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Declan Doherty > Sent: Friday, November 13, 2015 6:58 PM > To: dev@dpdk.org > Subject: [dpdk-dev] [PATCH v7 07/10] qat_crypto_pmd: Addition of a new QA= T > DPDK PMD. >=20 > This patch adds a PMD for the Intel Quick Assist Technology DH895xxC > hardware accelerator. > +Crypto Device Drivers > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > + > +|today| > + > + > +**Contents** > + It is best to omit the |today| since it isn't generally useful. Also, **Con= tent** is added automatically in the PDF out and not really required in Htm= l output so that can be omitted as well. > +Quick Assist Crypto Poll Mode Driver > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > + > +The QAT PMD provides poll mode crypto driver support for **Intel > +QuickAssist Technology DH895xxC** hardware accelerator. QAT PMD has > +current been tested on Fedora 21 64-bit with gcc and on the 4.3 > kernel.org Typo: current(ly) but it is probably clearer without that word. > +Features > +-------- > +QAT PMD has support for: > + > +Cipher algorithms: > +* RTE_CRYPTO_SYM_CIPHER_AES128_CBC > +* RTE_CRYPTO_SYM_CIPHER_AES256_CBC > +* RTE_CRYPTO_SYM_CIPHER_AES512_CBC The list needs to be separated from the previous line with a blank line to = render correctly. It would also be worth rending the algorithms as fixed wi= dth text. Cipher algorithms: * ``RTE_CRYPTO_SYM_CIPHER_AES128_CBC`` * ``RTE_CRYPTO_SYM_CIPHER_AES256_CBC`` * ``RTE_CRYPTO_SYM_CIPHER_AES512_CBC`` Same comments for next paragraph. > +Installation > +------------ > +To use the DPDK QAT PMD an SRIOV-enabled QAT kernel driver is required. > +The VF devices exposed by this driver will be used by QAT PMD. > + > +If you are running on kernel 4.3 or greater, see instructions for > "Installation using > +kernel.org QAT driver". If you're on a kernel earlier than 4.3, see > "Installation using the > +01.org QAT driver". The section references don't match the section names. These could also be l= inks like this: If you are running on kernel 4.3 or greater, see instructions for `Installa= tion using kernel.org driver`_ below. If you're on a kernel earlier than 4.3, see `Ins= tallation using 01.org QAT driver`_. > +Compiling the 01.org driver - notes: > +If using a later kernel and the build fails with an error relating to > strict_stroul not being available patch the following file: > + > +.. code-block:: console You could "use code-block:: diff" here to render the patch nicely in the do= cs. > +If build fails due to missing header files you may need to do following: > + * sudo yum install zlib-devel > + * sudo yum install openssl-devel Probably should be rendered as a code block with :: > + > +Installation using kernel.org driver > +------------------------------------ > + > +Assuming you are running on at least a 4.3 kernel, you can use the stock > kernel.org QAT > +driver to start the QAT hardware. > + > +Steps below assume > + * running DPDK on a platform with one DH895xCC device > + * on a kernel at least version 4.3 > + > +In BIOS ensure that SRIOV is enabled and VT-d is disabled. > + > +Ensure the QAT driver is loaded on your system, by executing: > + lsmod | grep qat The commands in this section should be rendered with :: Ensure the QAT driver is loaded on your system, by executing:: lsmod | grep qat > +Binding the available VFs to the DPDK UIO driver > +------------------------------------------------ > +The unbind command below assumes bdfs of 03:01.00-03:04.07, if yours are > different adjust the unbind command below. > + > +Make available to DPDK > + > +.. code-block:: console > + > + cd $(RTE_SDK) (See http://dpdk.org/doc/quick-start to install DPDK) > + "modprobe uio" > + "insmod ./build/kmod/igb_uio.ko" > + "for device in $(seq 1 4); do for fn in $(seq 0 7); do echo -n > 0000:03:0${device}.${fn} > > /sys/bus/pci/devices/0000\:03\:0${device}.${fn}/driver/unbind;done ;done" > + "echo "8086 0443" > /sys/bus/pci/drivers/igb_uio/new_id" > + This is too long to be rendered in PDF. Something like the following would = work better in the docs while being functionally the same: The unbind command below assumes ``bdfs`` of ``03:01.00-03:04.07``, if your= s are different adjust the unbind command below:: cd $RTE_SDK modprobe uio insmod ./build/kmod/igb_uio.ko for device in $(seq 1 4); do \ for fn in $(seq 0 7); do \ echo -n 0000:03:0${device}.${fn} > \ /sys/bus/pci/devices/0000\:03\:0${device}.${fn}/driver/unbind; \ done; \ done echo "8086 0443" > /sys/bus/pci/drivers/igb_uio/new_id You can use ``lspci -vvd:443`` to confirm that all devices are now in use b= y igb_uio kernel driver. John. --=20